Merge pull request #27 from stretchkennedy/upstream-ts-declarations

Add typescript typings

Author: boutell

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## main
+
+* Adds typescript typings
+
 ## 1.1.2 - 2022-01-20
 
 * Updates mocha to v9.

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;

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"
   },