summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/unique-slug/README.md
blob: 87f92f1d1b5f5c046965d97bdb88aa4941477eba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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 randomly generated bytes
converted into 8 hexadecimal characters.