@types/phonetic/README.md

TypeScript definitions for phonetic

# Installation
> `npm install --save @types/phonetic`

# Summary
This package contains type definitions for phonetic (https://github.com/TomFrost/node-phonetic).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/phonetic.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/phonetic/index.d.ts)
````ts
export interface PhoneticOptions {
    syllables?: number | undefined;
    seed?: string | undefined;
    phoneticSimplicity?: number | undefined;
    compoundSimplicity?: number | undefined;
    capFirst?: boolean | undefined;
}

export function generate(options?: PhoneticOptions): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Emmanuel N Kyeyune](https://github.com/emmanuelnk).