Server : nginx/1.20.1 System : Linux ccpf-production-2021 5.4.0-148-generic #165-Ubuntu SMP Tue Apr 18 08:53:12 UTC 2023 x86_64 User : forge ( 1000) PHP Version : 7.4.21 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory :  /proc/2399854/root/lib/node_modules/gulp/node_modules/ext/docs/string/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

# `String.random(options = { ... })` _(ext/string/random)_

Returns generated random string, contained only of ascii cars `a-z` and `0-1`.
By default returns string of length `10`.

```javascript
const random = require("ext/string/random");

random(); // "upcfns0i4t"
random({ length: 3 }); // "5tw"
```

## Supported options:

### `isUnique: false`

Ensures generated string is unique among ones already returned.

_Note: When not applying this setting, accidental generation of same string is still highly unlikely. Provided option is just to provide a mean to eliminate possibility of an edge case of duplicate string being returned_

### `length: 10`

Desired length of result string

### `charset: null`

Fixed list of possible characters

```javascript
random({ charset: "abc" }); // "bacbccbbac"
```