github-slugger-typescript

This project is a small Typescript fork of the github-slugger Javascript library from Dan Flettre.

The original library offers more options (maintainCase, reset()) that I don't need.

This project was bootstrapped with TSDX.

Install

npm install github-slugger-typescript

Usage

Keeping track of the previously slugged strings:

1import { GithubSlugger } from 'github-slugger-typescript';
2
3const slugger = new GithubSlugger();
4slugger.slug("foo");        // foo
5slugger.slug("Foo Bar");    // foo-bar
6slugger.slug("foo");        // foo-1
7slugger.slug("foo");        // foo-2

Useage without keeping track of previously slugged strings:

1import { slug } from 'github-slugger-typescript';
2
3slug("foo");        // foo
4slug("Foo Bar");    // foo-bar
5slug("foo");        // foo

License

MIT