It was forked from uslug.
20x faster than uslug.
Permissive slug generator that works with unicode. We keep only characters from the categories Letter, Number and Separator (see Unicode Categories) and the common CJK Unified Ideographs as defined in the version 6.0.0 of the Unicode specification.
Inspired by unicode-slugify. Note that this slug generator is different from node-slug which focus on translating unicode characters to english or latin equivalent.
$ yarn add @shelf/fast-uslug
import {fastUslug} from '@shelf/fast-uslug';
fastUslug('some string'); // some-stringimport {fastUslug} from '@shelf/fast-uslug';
fastUslug('Ґатунок Їхніх обценьок неперевершений!'); // 'ґатунок-їхніх-обценьок-неперевершений'
fastUslug('汉语/漢語'); // '汉语漢語'
fastUslug('Y U NO', {lower: false}); // 'Y-U-NO'
fastUslug('Y U NO', {spaces: true}); // 'y u no'
fastUslug('Y-U|NO', {allowedChars: '|'}); // 'yu|no'| uslug | @shelf/fast-uslug | Improvement |
|---|---|---|
| 10 words: 16,716 ops/s, ±0.64% | 10 words: 359,774 ops/s, ±0.36% | 22x |
| 100 words: 1,558 ops/s, ±0.50% | 100 words: 31,670 ops/s, ±0.36% | 20x |
| 1000 words: 156 ops/s, ±0.65% | 1000 words: 3,124 ops/s, ±0.48% | 20x |
You can run yarn benchmark to test on your own.
Generate a slug for the string passed.
Arguments
- string - The string you want to slugify.
- options - An optional object that can contain:
- allowedChars: a Set of chars that you want to be whitelisted. Default: '-_~'.
- lower: a Boolean to force to lower case the slug. Default: true.
- spaces: a Boolean to allow spaces. Default: false.
$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tagsMIT © Shelf