Slugifi

Slugifi is small package for creating a slug from a string.

Alert

I forgot my npm account password and can't login. so, I can't release a new version to fix a TypeScript issue. TypeScript users should copy declare module 'slugifi' and put it in a file named index.d.ts inside node_modules/slugifi folder. And this package is no longer maintained.

Release Notes (v1.0.7)

You can now remove special characters from string by enabling specialChars property from the options.

Installation

Npm :

$ npm install slugifi

Yarn :

$ yarn add slugifi

Pnpm :

$ pnpm add slugifi

Usage

ES6 :

import slugifi from 'slugifi';

slugifi('Random text'); // Outputs: random-text

CommonJS :

const slugifi = require('slugifi');

slugifi('Random text'); // Outputs: random-text

Options

slugifi('some text', {
  separator: '_', // defaults to '-'
  capitalize: true, // defaults to false
  specialChars: false, // defaults to true
});

License

MIT