Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Learning Center
  • Back to home
  • Dynamic values Modules
  • Airline
  • Animal
  • Color
  • Commerce
  • Company
  • Database
  • Datatype
  • Date
  • Finance
  • Food
  • Git
  • Hacker
  • Helpers
  • Image
  • Internet
  • Location
  • Lorem
  • Music
  • Number
  • Person
  • Phone
  • Science
  • String
  • System
  • Vehicle
  • Word
  1. Learning Center

Word

Module to return various types of words.

adjective#

Returns a random adjective.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

adverb#

Returns a random adverb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

conjunction#

Returns a random conjunction.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

interjection#

Returns a random interjection.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

preposition#

Returns a random preposition.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

sample#

Returns a random word, that can be an adjective, adverb, conjunction, interjection, noun, preposition, or verb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

verb#

Returns a random verb.
Parameters
NameTypeDefaultDescription
lengthnumberThe expected length of the word.
minnumberThe minimum length of the word.
maxnumberThe 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.
Returns: string
Examples

words#

Returns a random string containing some words separated by spaces.
Parameters
NameTypeDefaultDescription
countnumber{ min: 1, max: 3 }The number of words to return.
minnumberThe minimum length of the word.
maxnumberThe maximum length of the word.
Returns: string
Examples
Previous
Vehicle
Built with