Installation
npm install --save @types/project-name-generator
Summary
This package contains type definitions for project-name-generator (https://github.com/aceakash/project-name-generator#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator.
index.d.ts
/**
* Generate quirky names like spiffy-waterfall, sassy-bread, mature-dew-8239 to use wherever you need a random but memorable name.
*/
declare function generate(options?: generate.Options): generate.Project;
declare namespace generate {
interface Options {
/**
* Number of words generated (excluding number).
* All words will be adjectives, except the last one which will be a noun
* @default 2
*/
words?: number | undefined;
/**
* Whether a numeric suffix is generated or not. The number is between 1 - 9999, both inclusive.
* @default false
*/
number?: boolean | undefined;
/**
* Whether to output words beginning with the same letter or not
* @default false
*/
alliterative?: boolean | undefined;
}
interface Project {
raw: Array<string | number>;
dashed: string;
spaced: string;
}
}
export = generate;
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: none
Credits
These definitions were written by Piotr Błażejewicz.