stringing

KO | EN

gitlite — search

#react #ai #typescript #go #android #machine-learning #deep-learning #docker #nodejs #kubernetes #awesome-list #mcp #ios #open-source

(★ 17)

Generate random and unique string with custom dictionary

stringing Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# stringing

Generate random string with custom dictionary if you want to use a custom dictionary, just follow the rules. It's Fast, simple and lightweight.

**You are be able to change percent of usage any part of your dictionary.**

## Installation

with NPM:

`npm i stringing`

## Usage

- [stringing.generate](#stringinggenerate)
- [stringing.unique](#stringingunique)

#### in Node.js

```javascript
var stringing = require('stringing');
```

#### in browser

You should use the browserified version in built directory

```html
<script src='built/stringing.min.js'></script>
<script>
  // Everything is ready
  // Do what you want to do
</script>
```

### stringing.generate

Generating random string:

`stringing.generate(length, option, dictionary);`

#### length

Type: `Number`, Optional.

Default: `10`

length of your string.

#### option

Type: `Object`, Optional.

Default:

```
{
  number: 1,
  lower: 1,
  upper: 1,
  symbol: 1
}
```

Your object must includes one part of your dictionary at least.

You can change the percent usage of any part of your dictionary through increasing or decreasing the number of the part.

for comprehension see [examples](#examples).

#### dictionary

Type: `Object`, Optional.

Default:

```javascript
{
  lower: 'abcdefghijklmnopqrstuvwxyz',
  upper: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
  number: '1234567890',
  symbol: `~!@#$%^&*()_+.,<>?;'[]{}"|`
}
```

If you want use another dictionary or unique symbols or anything that you want, you can create your own dictionary and pass it.

for comprehension see [examples](#examples).

### stringing.unique

Generating unique string:

`stringing.unique(length)`

#### length

Type: `Number`, Optional.

Default: `18`

length of your string. Please pass a number greater than 18 for better unique string.

## Examples

```javascript
var stringing = require('stringing');

stringing.generate();
// '9R*uw&>UZ6'

stringing.generate(20, {
  number: 20,
  lower: 2,
  upper: 1
});
// '9imfr8c459IC8389378D' - Number is more

stringing.generate(20, { uniqueWords: 1, number: 4 }, {
  uniqueWords: 'JS-Node-_something',
  number: '123'
});
// 'n2t2-13122N11eo2ose2'

stringing.unique();
// '27BE1D4b69123091CD'

stringing.unique(25);
// 'C44b6eE2F647A935HgB0HdB1b'
```

## Contributing, Idea, Issue

Feel free to fill an issue or create a pull request, I'll check it ASAP.

Just remember, lint and build your code:

`gulp lint build`

## LICENSE

MIT

stringing

stringing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

stringing

stringing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README