Word
adjective
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
adverb
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
conjunction
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
interjection
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
preposition
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
sample
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
verb
Name | Type | Default | Description |
---|---|---|---|
length | number | The expected length of the word. | |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. | |
strategy | 'fail' | 'closest' | 'shortest' | 'longest' | 'any-length' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:- fail : Throws an error if no words with the given length are found.- shortest : Returns any of the shortest words.- closest : Returns any of the words closest to the given length.- longest : Returns any of the longest words.- any-length : Returns a word with any length. |
words
Name | Type | Default | Description |
---|---|---|---|
count | number | { min: 1, max: 3 } | The number of words to return. |
min | number | The minimum length of the word. | |
max | number | The maximum length of the word. |