aswi2020vldc-gitlab/templetes/node_modules/unique-slug/README.md @ 143404cb
1 | 3a515b92 | cagy | unique-slug
|
---|---|---|---|
2 | ===========
|
||
3 | |||
4 | Generate a unique character string suitible for use in files and URLs. |
||
5 | |||
6 | ```
|
||
7 | var uniqueSlug = require('unique-slug') |
||
8 | |||
9 | var randomSlug = uniqueSlug() |
||
10 | var fileSlug = uniqueSlug('/etc/passwd') |
||
11 | ```
|
||
12 | |||
13 | ### uniqueSlug(*str*) → String (8 chars)
|
||
14 | |||
15 | If *str* is passed in then the return value will be its murmur hash in
|
||
16 | hex. |
||
17 | |||
18 | If *str* is not passed in, it will be 4 randomly generated bytes
|
||
19 | converted into 8 hexadecimal characters. |