@types/sluggo
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Installation

npm install --save @types/sluggo

Summary

This package contains type definitions for sluggo (https://github.com/apostrophecms/sluggo).

Details

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;

Additional Details

  • Last updated: Mon, 06 May 2024 19:06:39 GMT
  • Dependencies: none

Credits

These definitions were written by Reece Dunham.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/sluggo

Weekly Downloads

19

Version

1.0.0

License

MIT

Unpacked Size

3.72 kB

Total Files

5

Last publish

Collaborators

  • types