npm install --save @types/sluggo
This package contains type definitions for sluggo (https://github.com/apostrophecms/sluggo).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sluggo.
declare namespace sluggo {
interface Options {
/**
* The separator character to use. Defaults to "-".
*/
separator?: string | undefined;
/**
* A string or list of strings to permit in the output.
*/
allow?: string | string[] | undefined;
}
}
/**
* Generates a slug.
* @param input The string to generate a slug for.
* @param options Customize the slug generator's behavior.
* @returns The generated slug.
*/
declare function sluggo(input: string, options?: sluggo.Options): string;
export = sluggo;
export as namespace sluggo;
- Last updated: Mon, 06 May 2024 19:06:39 GMT
- Dependencies: none
These definitions were written by Reece Dunham.