mirror of
https://github.com/S2-/securerandomstring.git
synced 2025-08-03 02:40:04 +02:00
Add support for 'sync' API. Updates code, tests and docs.
This commit is contained in:
47
README.md
47
README.md
@@ -1,33 +1,52 @@
|
||||
# secure-random-string
|
||||
a node module that generates a secure random string with a given length
|
||||
|
||||
Node.js module that generates a cryptographically secure random string with a given length
|
||||
|
||||
## Usage
|
||||
`require` it
|
||||
|
||||
```
|
||||
```javascript
|
||||
var srs = require('secure-random-string');
|
||||
```
|
||||
|
||||
### Default behavior: Generate a random string 32 characters long.
|
||||
|
||||
generate a random string that is 32 chars long (the default)
|
||||
```
|
||||
```javascript
|
||||
// Sync
|
||||
var result = srs();
|
||||
|
||||
// Async
|
||||
srs(function(sr) {
|
||||
console.log(sr);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Options: length, urlsafe
|
||||
|
||||
generate a random string that is 256 chars long
|
||||
```
|
||||
srs({length: 256}, function(sr) {
|
||||
Optionally, you can specify a 'length' option to specify a length.
|
||||
|
||||
The 'urlsafe' option replaces a potential `+` character with `-` and the `/` character
|
||||
with `_`, created a valid [base64url](https://en.wikipedia.org/wiki/Base64) format string.
|
||||
|
||||
```javascript
|
||||
// sync
|
||||
var result = srs({length: 256, urlsafe:true});
|
||||
|
||||
// async
|
||||
srs({length: 256, urlsafe:true}, function(sr) {
|
||||
console.log(sr);
|
||||
});
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
generate a random string that is 20 chars long and is url safe (can be used as a url token)
|
||||
```
|
||||
srs({length: 20, urlsafe: true}, function(sr) {
|
||||
console.log(sr);
|
||||
});
|
||||
```
|
||||
|
Reference in New Issue
Block a user