slug
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/slug package

    5.1.0 • Public • Published

    slug

    Slugifies strings, even when they contain Unicode.

    Make strings URL-safe.

    • Respects RFC 3986
    • No dependencies
    • Works in browser (window.slug) and AMD/CommonJS-flavoured module loaders
    npm install slug
    

    Example

    var slug = require('slug')
    var print = console.log.bind(console, '>')
    
    print(slug('i love unicode'))
    // > i-love-unicode
    
    print(slug('i love unicode', '_')) // If you prefer something else than `-` as separator
    // > i_love_unicode
    
    slug.charmap['♥'] = 'freaking love' // change default charmap or use option {charmap:{…}} as 2. argument
    print(slug('I ♥ UNICODE'))
    // > i-freaking-love-unicode
    
    print(slug('Telephone-Number')) // lower case by default
    // > telephone-number
    
    print(slug('Telephone-Number', {lower: false})) // If you want to preserve case
    // > Telephone-Number
    
    // We try to provide sensible defaults.
    // So Cyrillic text will be transliterated as if it were Russian:
    print(slug('маленький подъезд'))
    // > malenkij-poduezd
    
    // But maybe you know it's Bulgarian:
    print(slug('маленький подъезд', { locale: 'bg' }))
    // > malenykiy-podaezd
    
    print(slug('unicode ♥ is ☢'))
    // > unicode-love-is
    
    slug.extend({'☢': 'radioactive'})
    print(slug('unicode ♥ is ☢'))
    // > unicode-love-is-radioactive
    
    // slug.extend() modifies the default charmap for the entire process.
    // If you need to reset charmap and multicharmap, use slug.reset():
    
    slug.reset()
    print(slug('unicode ♥ is ☢'))
    // > unicode-love-is
    
    // Custom removal of characters from resulting slug. Let's say that we want to
    // remove all numbers for some reason.
    print(slug('one 1 two 2 three 3'))
    // > one-1-two-2-three-3
    print(slug('one 1 two 2 three 3', { remove: /[0-9]/g }))
    // > one-two-three

    options

    // options is either object or replacement (sets options.replacement)
    slug('string', [{options} || 'replacement']);
    slug.defaults.mode ='pretty';
    slug.defaults.modes['rfc3986'] = {
        replacement: '-',      // replace spaces with replacement
        remove: null,          // (optional) regex to remove characters
        lower: true,           // result in lower case
        charmap: slug.charmap, // replace special characters
        multicharmap: slug.multicharmap // replace multiple code unit characters
        trim: true             // trim leading and trailing replacement chars
    };
    slug.defaults.modes['pretty'] = {
        replacement: '-',
        remove: null,
        lower: false,
        charmap: slug.charmap,
        multicharmap: slug.multicharmap
        trim: true              
    };

    Testing Powered By SauceLabs

    Install

    npm i slug

    DownloadsWeekly Downloads

    178,106

    Version

    5.1.0

    License

    MIT

    Unpacked Size

    30.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • trott