diff options
Diffstat (limited to 'node_modules/unique-slug/README.md')
| -rw-r--r-- | node_modules/unique-slug/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/node_modules/unique-slug/README.md b/node_modules/unique-slug/README.md new file mode 100644 index 000000000..52de4277d --- /dev/null +++ b/node_modules/unique-slug/README.md @@ -0,0 +1,20 @@ +unique-slug +=========== + +Generate a unique character string suitible for use in files and URLs. + +``` +var uniqueSlug = require('unique-slug') + +var randomSlug = uniqueSlug() +var fileSlug = uniqueSlug('/etc/passwd') +``` + +### uniqueSlug(*str*) → String (8 chars) + +If *str* is passed in then the return value will be its murmur hash in +hex. + +If *str* is not passed in, it will be 4 bytes coverted into 8 hex +characters, generated by `crypto.pseudoRandomBytes`. + |