mirror of
https://github.com/S2-/securerandomstring.git
synced 2025-08-02 18:30:04 +02:00
31839fea0b
* Alphabetic options added into Readme.md * Add empty space after 'if' in new option validation
68 lines
1.3 KiB
Markdown
68 lines
1.3 KiB
Markdown
# secure-random-string
|
|
|
|
Node.js module that generates a cryptographically secure random string with a given length
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var srs = require('secure-random-string');
|
|
```
|
|
|
|
### Default behavior: Generate a random string 32 characters long.
|
|
|
|
```javascript
|
|
// Sync
|
|
var result = srs();
|
|
|
|
// Async
|
|
srs(function(err, sr) {
|
|
console.log(sr);
|
|
});
|
|
|
|
```
|
|
|
|
### Options: length
|
|
|
|
Optionally, you can specify a 'length' option to specify a length.
|
|
|
|
```javascript
|
|
// sync
|
|
var result = srs({length: 256});
|
|
|
|
// async
|
|
srs({length: 256}, function(err, sr) {
|
|
console.log(sr);
|
|
});
|
|
```
|
|
### Options: alphabetic
|
|
|
|
Optionally, you can specify a 'alphabetic' option to get a alphabetical chars only.
|
|
|
|
```javascript
|
|
// sync
|
|
var result = srs({alphabetic: true});
|
|
|
|
// async
|
|
srs({alphabetic: true}, function(err, sr) {
|
|
console.log(sr);
|
|
});
|
|
```
|
|
## Error handling
|
|
|
|
|
|
An error is possible if there is not enough accumulated entropy to generate cryptographically strong data. In other words, this will not block even if all entropy sources are drained. Note that the sync API throws an exception, while
|
|
the async API returns the error to the callback.
|
|
|
|
## Author
|
|
|
|
[Simon Santoro](https://github.com/S2-)
|
|
|
|
## Contributors
|
|
|
|
[Mark Stosberg](https://github.com/markstos)
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/aheckmann/node-ses/blob/master/LICENSE)
|
|
|