This is a fork. you might want the original one from Sindresorhus. check that out. This only transpiles it to be compatible to older browsers.

slugify

Slugify a string

Useful for URLs, filenames, and IDs.

Install

$ npm install @sindresorhus/slugify

Usage

1const slugify = require('@sindresorhus/slugify');
2
3slugify('I ♥ Dogs');
4//=> 'i-love-dogs'
5
6slugify('  Déjà Vu!  ');
7//=> 'deja-vu'
8
9slugify('fooBar 123 $#%');
10//=> 'foo-bar-123'
11
12slugify('BAR and baz', {separator: '_'});
13//=> 'bar_and_baz'
14
15slugify('I ♥ 🦄 & 🐶', {
16  customReplacements: [
17    ['🐶', 'dog']
18  ]
19});
20//=> 'i-love-unicorn-and-dog'

API

slugify(input, [options])

input

Type: string

options

Type: Object

separator

Type: string
Default: -

customReplacements

Type: Array
Default: [ ['&', 'and'], ['🦄', 'unicorn'], ['♥', 'love'] ]

Specifying this only replaces the default if you set an item with the same key, like &.

Related

• slugify-cli - CLI for this module
• filenamify - Convert a string to a valid safe filename

License

MIT © Sindre Sorhus