From 7bb5be8a19c4e75b67a2d32dc536fc107d78d814 Mon Sep 17 00:00:00 2001 From: Tim Kennedy Date: Wed, 15 Jun 2022 13:08:15 +1000 Subject: [PATCH 1/4] Add typescript bindings --- index.d.ts | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 index.d.ts 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; From aa3043449f62ade1b19dbf662a33952de9129416 Mon Sep 17 00:00:00 2001 From: Tim Kennedy Date: Wed, 15 Jun 2022 13:51:43 +1000 Subject: [PATCH 2/4] Add changelog entry --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3112603..6c2852b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## main + +* Adds typescript bindings + ## 1.1.2 - 2022-01-20 * Updates mocha to v9. From ee46ddc9779b6b3499d478ae94a23cae23654ff2 Mon Sep 17 00:00:00 2001 From: Tim Kennedy Date: Wed, 15 Jun 2022 13:57:00 +1000 Subject: [PATCH 3/4] Add types to package.json --- package.json | 1 + 1 file changed, 1 insertion(+) 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" }, From 54ca731114a64c27a7639248cc7a4981df6216ee Mon Sep 17 00:00:00 2001 From: Tim Kennedy Date: Wed, 15 Jun 2022 14:01:32 +1000 Subject: [PATCH 4/4] Fix changelog entry - typings, not bindings --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c2852b..cb0d7fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## main -* Adds typescript bindings +* Adds typescript typings ## 1.1.2 - 2022-01-20