PHP's str_shuffle in TypeScript

How to use

Install via yarn add locutus and import: import { str_shuffle } from 'locutus/php/strings/str_shuffle'.

Or with CommonJS: const { str_shuffle } = require('locutus/php/strings/str_shuffle')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	var $shuffled = str_shuffle("abcdef") var $result = $shuffled.length	6

Here's what our current TypeScript equivalent to PHP's str_shuffle looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function str_shuffle(input: string | null | undefined): string

export function str_shuffle(...providedArgs: [input?: string | null | undefined]): string {
  //  discuss at: https://locutus.io/php/str_shuffle/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $shuffled = str_shuffle("abcdef")
  //   example 1: var $result = $shuffled.length
  //   returns 1: 6

  if (providedArgs.length === 0) {
    throw new Error('Wrong parameter count for str_shuffle()')
  }
  const [input] = providedArgs
  if (input === null) {
    return ''
  }

  let str = String(input)

  let newStr = ''
  let rand
  let i = str.length

  while (i) {
    rand = Math.floor(Math.random() * i)
    newStr += str.charAt(rand)
    str = str.substring(0, rand) + str.substr(rand + 1)
    i--
  }

  return newStr
}

export function str_shuffle(...providedArgs) {
  //  discuss at: https://locutus.io/php/str_shuffle/
  // original by: Brett Zamir (https://brett-zamir.me)
  //   example 1: var $shuffled = str_shuffle("abcdef")
  //   example 1: var $result = $shuffled.length
  //   returns 1: 6

  if (providedArgs.length === 0) {
    throw new Error('Wrong parameter count for str_shuffle()')
  }
  const [input] = providedArgs
  if (input === null) {
    return ''
  }

  let str = String(input)

  let newStr = ''
  let rand
  let i = str.length

  while (i) {
    rand = Math.floor(Math.random() * i)
    newStr += str.charAt(rand)
    str = str.substring(0, rand) + str.substr(rand + 1)
    i--
  }

  return newStr
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP strings functions

Star