elegant-slug v0.0.2

elegant-slug

🧹 Elegant & SEO-friendly slugger for URLs

Installation

Using npm:

npm install elegant-slug

Using yarn:

yarn add elegant-slug

Usage

import slug from 'elegant-slug';

slug('déjà vu');
// 'deja-vu'

slug('some title', { separator: 'underscore' });
// 'some_title'

slug('this is a really long title and it should not exceed 50 characters', {
  maxLength: 50,
});
// 'this-is-a-really-long-title'

slug('LOWERCASE---PLEASE!', {
  letterCase: 'lowercase',
});
// 'lowercase-please'

slug('مرحبا مرحبا', {
  charMap: {
    ا: 'a',
    ب: 'b',
    ح: 'h',
    ر: 'r',
    م: 'm',
  },
});
// mrhba-mrhba

slug('this is the title', { unique: true });
// this-is-the-title-fqgkhg5dra2

API Documentation

slug(str: string, options?: Options)

str

String to be converted into a slug

options (optional)

Additional options to format the slug. See below for the available options.

Options