taler/wallet-core
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Activity
da3c480a32
wallet-core/node_modules/randomatic/README.md

174 lines
7.0 KiB
Markdown
Raw Normal View History

node_modules
2017-08-14 05:01:11 +02:00
# randomatic [![NPM version](https://img.shields.io/npm/v/randomatic.svg?style=flat)](https://www.npmjs.com/package/randomatic) [![NPM monthly downloads](https://img.shields.io/npm/dm/randomatic.svg?style=flat)](https://npmjs.org/package/randomatic) [![NPM total downloads](https://img.shields.io/npm/dt/randomatic.svg?style=flat)](https://npmjs.org/package/randomatic) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/randomatic.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/randomatic)
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
update packages
2018-09-20 02:56:13 +02:00
> Generate randomized strings of a specified length using simple character sequences. The original generate-password.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
## Install
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
Install with [npm](https://www.npmjs.com/):
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
```sh
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
$ npm install --save randomatic
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
```
## Usage
```js
var randomize = require('randomatic');
```
## API
```js
randomize(pattern, length, options);
update packages
2018-09-20 02:56:13 +02:00
randomize.isCrypto;
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
```
update packages
2018-09-20 02:56:13 +02:00
* `pattern` **{String}**: (required) The pattern to use for randomizing
* `length` **{Number}**: (optional) The length of the string to generate
* `options` **{Object}**: (optional) See available [options](#options)
* `randomize.isCrypto` will be `true` when a cryptographically secure function is being used to generate random numbers. The value will be `false` when the function in use is `Math.random`.
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
### pattern
> The pattern to use for randomizing
Patterns can contain any combination of the below characters, specified in any order.
**Example:**
To generate a 10-character randomized string using all available characters:
```js
randomize('*', 10);
update packages
2018-09-20 02:56:13 +02:00
//=> 'x2_^-5_T[$'
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
randomize('Aa0!', 10);
update packages
2018-09-20 02:56:13 +02:00
//=> 'LV3u~BSGhw'
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
```
* `a`: Lowercase alpha characters (`abcdefghijklmnopqrstuvwxyz'`)
* `A`: Uppercase alpha characters (`ABCDEFGHIJKLMNOPQRSTUVWXYZ'`)
* `0`: Numeric characters (`0123456789'`)
* `!`: Special characters (`~!@#$%^&()_+-={}[];\',.`)
* `*`: All characters (all of the above combined)
* `?`: Custom characters (pass a string of custom characters to the options)
### length
> the length of the string to generate
**Examples:**
* `randomize('A', 5)` will generate a 5-character, uppercase, alphabetical, randomized string, e.g. `KDJWJ`.
* `randomize('0', 2)` will generate a 2-digit random number
* `randomize('0', 3)` will generate a 3-digit random number
* `randomize('0', 12)` will generate a 12-digit random number
* `randomize('A0', 16)` will generate a 16-character, alpha-numeric randomized string
If `length` is left undefined, the length of the pattern in the first parameter will be used. For example:
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
* `randomize('00')` will generate a 2-digit random number
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
* `randomize('000')` will generate a 3-digit random number
* `randomize('0000')` will generate a 4-digit random number...
* `randomize('AAAAA')` will generate a 5-character, uppercase alphabetical random string...
These are just examples, [see the tests](./test.js) for more use cases and examples.
#### chars
Type: `String`
Default: `undefined`
Define a custom string to be randomized.
**Example:**
* `randomize('?', 20, {chars: 'jonschlinkert'})` will generate a 20-character randomized string from the letters contained in `jonschlinkert`.
* `randomize('?', {chars: 'jonschlinkert'})` will generate a 13-character randomized string from the letters contained in `jonschlinkert`.
update packages
2018-09-20 02:56:13 +02:00
#### exclude
Type: `String|Array`
Default: `undefined`
Specify a string or array of characters can are excluded from the possible characters used to generate the randomized string.
**Example:**
* `randomize('*', 20, { exclude: '0oOiIlL1' })` will generate a 20-character randomized string using all of possible characters except for `0oOiIlL1`.
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
## Usage Examples
* `randomize('A', 4)` (_whitespace insenstive_) would result in randomized 4-digit uppercase letters, like, `ZAKH`, `UJSL`... etc.
* `randomize('AAAA')` is equivelant to `randomize('A', 4)`
* `randomize('AAA0')` and `randomize('AA00')` and `randomize('A0A0')` are equivelant to `randomize('A0', 4)`
* `randomize('aa')`: results in double-digit, randomized, lower-case letters (`abcdefghijklmnopqrstuvwxyz`)
* `randomize('AAA')`: results in triple-digit, randomized, upper-case letters (`ABCDEFGHIJKLMNOPQRSTUVWXYZ`)
node_modules
2017-08-14 05:01:11 +02:00
* `randomize('0', 6)`: results in six-digit, randomized numbers (`0123456789`)
* `randomize('!', 5)`: results in single-digit randomized, _valid_ non-letter characters (`~!@#$%^&()_+-={}[]
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
* `randomize('A!a0', 9)`: results in nine-digit, randomized characters (any of the above)
_The order in which the characters are defined is insignificant._
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
## About
### Related projects
* [pad-left](https://www.npmjs.com/package/pad-left): Left pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-left "Left pad a string with zeros or a specified string. Fastest implementation.")
* [pad-right](https://www.npmjs.com/package/pad-right): Right pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-right "Right pad a string with zeros or a specified string. Fastest implementation.")
* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Contributors
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
update packages
2018-09-20 02:56:13 +02:00
| **Commits** | **Contributor** |
| --- | --- |
| 56 | [jonschlinkert](https://github.com/jonschlinkert) |
| 2 | [realityking](https://github.com/realityking) |
| 1 | [TrySound](https://github.com/TrySound) |
| 1 | [Drag0s](https://github.com/Drag0s) |
| 1 | [paulmillr](https://github.com/paulmillr) |
| 1 | [sunknudsen](https://github.com/sunknudsen) |
| 1 | [faizulhaque-tp](https://github.com/faizulhaque-tp) |
| 1 | [michaelrhodes](https://github.com/michaelrhodes) |
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
### Building docs
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
node_modules
2017-08-14 05:01:11 +02:00
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
node_modules
2017-08-14 05:01:11 +02:00
To generate the readme, run the following command:
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
```sh
node_modules
2017-08-14 05:01:11 +02:00
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
```
### Running tests
node_modules
2017-08-14 05:01:11 +02:00
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
```sh
node_modules
2017-08-14 05:01:11 +02:00
$ npm install && npm test
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
```
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
### Author
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
node_modules
2017-08-14 05:01:11 +02:00
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.
2017-04-20 03:09:25 +02:00
### License
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
update packages
2018-09-20 02:56:13 +02:00
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
node_modules
2017-08-14 05:01:11 +02:00
Released under the [MIT License](LICENSE).
add node_modules to address #4364
2016-10-10 03:43:44 +02:00
***
update packages
2018-09-20 02:56:13 +02:00
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.7.0, on August 08, 2018._
Reference in New Issue Copy Permalink