@types/uslug v1.0.4

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

// Type definitions for uslug 1.0
// Project: https://github.com/jeremys/uslug
// Definitions by: Junyoung Choi <https://github.com/rokt33r>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * 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: Fri, 02 Jul 2021 18:04:54 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Junyoung Choi.