Installation
npm install --save @types/uslug
Summary
This package contains type definitions for uslug (https://github.com/jeremys/uslug).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uslug.
index.d.ts
/**
* Generate a slug for the string passed.
* @param value The string you want to slugify
* @param options An optional object that can contain:
* - allowedChars: a String of chars that you want to be whitelisted. Default: '-_~'.
* - lower: a Boolean to force to lower case the slug. Default: true.
* - spaces: a Boolean to allow spaces. Default: false.
*/
declare function uslug(value: string, options?: uslug.UslugOptions): string;
declare namespace uslug {
interface UslugOptions {
allowedChars?: string | undefined;
lower?: boolean | undefined;
spaces?: boolean | undefined;
}
}
export = uslug;
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: none
Credits
These definitions were written by Junyoung Choi.