skewered

The simplest slugify module in the universe.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
skewered
011.0.05 years ago5 years agoMinified + gzip package size for skewered in KB

Readme

The simplest slugify module in the universe.

Prerequisites

Any input character that is not a-z, 0-9 or - will be lowercased or replaced with a hyphen.
  • Therefore, use other modifiers beforehand, e.g. diacritics

Resulting values:
  • Only contain a-z, 0-9, -
  • Do not contain leading or trailing hyphens
  • Do not contain repeating hyphens

Installation

$ npm install skewered

Usage

const skewered = require("skewered");
const before =
  "- (this),is.a+test-that*must:work;or&else#it%fails big/*/time  1'2'3 123--xyz----Möbius _";
const after =
  "this-is-a-test-that-must-work-or-else-it-fails-big-time-1-2-3-123-xyz-m-bius";

console.log(skewered(before) === after);
//=> true

License

ISC © Buster Collings