Merge pull request #15 from sbj42/add-types

Fix issue #14 - add TypeScript declarations
mrsharpoblunto · Oct 13, 2018 · 3cf1280 · 3cf1280
2 parents bc5160d + 5f60596
commit 3cf1280
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -0,0 +1,11 @@
+declare module 'foswig' {
+    class Foswig {
+        constructor(order: number);
+
+        addWordsToChain(words: string[]): void;
+        addWordToChain(word: string): void;
+        generateWord(minLength?: number, maxLength?: number, allowDuplicates?: boolean, maxAttempts?: number): string;
+    }
+
+    export = Foswig;
+}
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "version": "1.1.1",
   "description": "A library that can generate legible pseudo random words based off an input dictionary using markov chains",
   "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "dependencies": {},
   "devDependencies": {
     "chai": "^1.9.1",