# @types/project-name-generator

> TypeScript definitions for project-name-generator

Latest version **2.1.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/project-name-generator
pnpm add @types/project-name-generator
yarn add @types/project-name-generator
bun add @types/project-name-generator
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2023-11-07 |
| First published | 2020-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51384 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/project-name-generator
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator
- npm.io page: https://npm.io/package/@types/project-name-generator

## Recent versions

- 2.1.3 (latest) — 2023-11-07
- 2.1.1 (ts3.6) — 2021-07-08
- 2.1.0 (ts3.0) — 2020-06-16
- 2.1.2 — 2023-10-18

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/project-name-generator/index.d.ts)
````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](https://github.com/peterblazejewicz).

---
_Source: https://npm.io/package/@types/project-name-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._