@cvpcasada/slugify

    0.3.3 • Public • Published

    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 Build Status

    Slugify a string

    Useful for URLs, filenames, and IDs.

    Install

    $ npm install @sindresorhus/slugify
    

    Usage

    const slugify = require('@sindresorhus/slugify');
    
    slugify('I ♥ Dogs');
    //=> 'i-love-dogs'
    
    slugify('  Déjà Vu!  ');
    //=> 'deja-vu'
    
    slugify('fooBar 123 $#%');
    //=> 'foo-bar-123'
    
    slugify('BAR and baz', {separator: '_'});
    //=> 'bar_and_baz'
    
    slugify('I ♥ 🦄 & 🐶', {
      customReplacements: [
        ['🐶', 'dog']
      ]
    });
    //=> '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

    License

    MIT © Sindre Sorhus

    Install

    npm i @cvpcasada/slugify

    DownloadsWeekly Downloads

    2

    Version

    0.3.3

    License

    MIT

    Unpacked Size

    9.09 kB

    Total Files

    5

    Last publish

    Collaborators

    • cvpcasada