@apiverve/wordrhymes 1.1.14 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +11 -101
  2. package/index.d.ts +15 -9
  3. package/package.json +5 -6
package/README.md CHANGED
@@ -126,108 +126,18 @@ async function makeRequest() {
126
126
  "error": null,
127
127
  "data": {
128
128
  "word": "blue",
129
- "rhymeCount": 20,
129
+ "rhymeCount": 10,
130
130
  "rhymes": [
131
- {
132
- "score": 3,
133
- "pron": "D EH2 B L UW1",
134
- "word": "deblois"
135
- },
136
- {
137
- "score": 2,
138
- "pron": "B AH0 L UW1",
139
- "word": "ballou"
140
- },
141
- {
142
- "score": 2,
143
- "pron": "B IH0 L UW1",
144
- "word": "bellew"
145
- },
146
- {
147
- "score": 2,
148
- "pron": "K EH2 R AH0 L UW1",
149
- "word": "carilou"
150
- },
151
- {
152
- "score": 2,
153
- "pron": "SH AH0 L UW1",
154
- "word": "chaloux"
155
- },
156
- {
157
- "score": 2,
158
- "pron": "K L UW1",
159
- "word": "clue"
160
- },
161
- {
162
- "score": 2,
163
- "pron": "F L UW1",
164
- "word": "flew"
165
- },
166
- {
167
- "score": 2,
168
- "pron": "F L UW1",
169
- "word": "flu"
170
- },
171
- {
172
- "score": 2,
173
- "pron": "F L UW1",
174
- "word": "flue"
175
- },
176
- {
177
- "score": 2,
178
- "pron": "G L UW1",
179
- "word": "glew"
180
- },
181
- {
182
- "score": 2,
183
- "pron": "G L UW1",
184
- "word": "glue"
185
- },
186
- {
187
- "score": 2,
188
- "pron": "HH AH2 L AH0 B AH0 L UW1",
189
- "word": "hullabaloo"
190
- },
191
- {
192
- "score": 2,
193
- "pron": "K L UW1",
194
- "word": "klu"
195
- },
196
- {
197
- "score": 2,
198
- "pron": "L UW1",
199
- "word": "leu"
200
- },
201
- {
202
- "score": 2,
203
- "pron": "L UW1",
204
- "word": "lew"
205
- },
206
- {
207
- "score": 2,
208
- "pron": "L UW1",
209
- "word": "lieu"
210
- },
211
- {
212
- "score": 2,
213
- "pron": "L UW1",
214
- "word": "loo"
215
- },
216
- {
217
- "score": 2,
218
- "pron": "L UW1",
219
- "word": "lou"
220
- },
221
- {
222
- "score": 2,
223
- "pron": "L UW1",
224
- "word": "louw"
225
- },
226
- {
227
- "score": 2,
228
- "pron": "L UW1",
229
- "word": "loux"
230
- }
131
+ "deblois",
132
+ "ballou",
133
+ "bellew",
134
+ "carilou",
135
+ "chaloux",
136
+ "clue",
137
+ "flew",
138
+ "flu",
139
+ "flue",
140
+ "glew"
231
141
  ]
232
142
  }
233
143
  }
package/index.d.ts CHANGED
@@ -4,24 +4,30 @@ declare module '@apiverve/wordrhymes' {
4
4
  secure?: boolean;
5
5
  }
6
6
 
7
+ /**
8
+ * Describes fields the current plan does not unlock. Locked fields arrive as null
9
+ * in `data`; `locked_fields` names them, using dot paths for nested fields.
10
+ * Absent when the plan unlocks everything.
11
+ */
12
+ export interface PremiumInfo {
13
+ message: string;
14
+ upgrade_url: string;
15
+ locked_fields: string[];
16
+ }
17
+
7
18
  export interface wordrhymesResponse {
8
19
  status: string;
9
20
  error: string | null;
10
21
  data: RhymingWordsData;
11
22
  code?: number;
23
+ premium?: PremiumInfo;
12
24
  }
13
25
 
14
26
 
15
27
  interface RhymingWordsData {
16
- word: string;
17
- rhymeCount: number;
18
- rhymes: Rhyme[];
19
- }
20
-
21
- interface Rhyme {
22
- score: number;
23
- pron: string;
24
- word: string;
28
+ word: null | string;
29
+ rhymeCount: number | null;
30
+ rhymes: (null | string)[];
25
31
  }
26
32
 
27
33
  export default class wordrhymesWrapper {
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@apiverve/wordrhymes",
3
- "version": "1.1.14",
3
+ "version": "1.2.0",
4
4
  "description": "Word Rhymes is a simple tool for getting word rhymes. It returns a list of rhyming words.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "sideEffects": false,
8
8
  "engines": {
9
- "node": ">=14.0.0"
9
+ "node": ">=18.0.0"
10
10
  },
11
11
  "files": [
12
12
  "index.js",
@@ -23,7 +23,7 @@
23
23
  "directory": "npm"
24
24
  },
25
25
  "keywords": [
26
- ""
26
+ "word rhymes", "word rhymes generator", "word rhymes api", "word rhymes tool", "word rhymes software"
27
27
  ],
28
28
  "author": {
29
29
  "name": "APIVerve",
@@ -41,8 +41,7 @@
41
41
  "dotenv": "^16.4.7"
42
42
  },
43
43
  "dependencies": {
44
- "node-fetch": "^3.3.2",
45
- "promise": "^8.3.0",
46
- "axios": "1.13.2"
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
47
46
  }
48
47
  }