diff --git a/CHANGELOG.md b/CHANGELOG.md index 3112603..cb0d7fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## main + +* Adds typescript typings + ## 1.1.2 - 2022-01-20 * Updates mocha to v9. diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..da59d59 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,18 @@ +declare type WordsOptions = { + min?: number; + max?: number; + exactly?: number; + maxLength?: number; + wordsPerString?: number; + seperator?: string; + formatter?: (word: string, index: number) => string; +}; + +declare type JoinedWordsOptions = WordsOptions & { join: string; }; + +declare function words(count: number): string[]; +declare function words(options: WordsOptions): string[]; +declare function words(options: JoinedWordsOptions): string; + +export const wordsList: string[]; +export default words; diff --git a/package.json b/package.json index 1314530..e5d1342 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "version": "1.1.2", "description": "Generate one or more common English words", "main": "index.js", + "types": "index.d.ts", "scripts": { "test": "mocha tests/test.js" },