Documentation

Slug. Textual value inside is always guaranteed to have the following qualities:

• it's not empty;
• it consists only of alpha-numeric groups of characters (words) separated by '-' dashes in such a way that entire slug cannot start or end in a dash and also two dashes in a row cannot be found;
• every character with defined notion of case is lower-cased.

Slugs are good for semantic URLs and also can be used as identifier of a sort in some cases.

Create a Slug from a Text value, all necessary transformations are applied. The argument of this function can be title of an article or something like that.

Note that the result is inside MonadThrow, that means you can just get it in Maybe, in more complex contexts it will throw SlugException exception using InvalidInput constructor.

This function also has a useful property:

mkSlug = mkSlug >=> mkSlug . unSlug

Get textual representation of a Slug.

Convert a Text into a Slug only when it is already valid slug.

This function can throw the SlugException exception using InvalidSlug constructor.

Ensure that given Slug is not longer than given maximum number of characters. If truncated slug ends in a dash, remove that dash too. (Dash at the end would violate properties described in documentation for Slug.)

If the first argument is not a positive number, SlugException is thrown using InvalidLength constructor.

This exception is thrown by mkSlug when its input cannot be converted into a proper Slug.