Word
Module to return various types of words.
adjective
Returns an adjective of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.adjective(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.adjective() // 'pungent'
faker.word.adjective(5) // 'slimy'
faker.word.adjective(100) // 'complete'
faker.word.adjective({ strategy: 'shortest' }) // 'icy'
faker.word.adjective({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'distant'
Source
adverb
Returns an adverb of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.adverb(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.adverb() // 'quarrelsomely'
faker.word.adverb(5) // 'madly'
faker.word.adverb(100) // 'sadly'
faker.word.adverb({ strategy: 'shortest' }) // 'too'
faker.word.adverb({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'sweetly'
Source
conjunction
Returns a conjunction of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.conjunction(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.conjunction() // 'in order that'
faker.word.conjunction(5) // 'since'
faker.word.conjunction(100) // 'as long as'
faker.word.conjunction({ strategy: 'shortest' }) // 'or'
faker.word.conjunction({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'hence'
Source
interjection
Returns an interjection of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.interjection(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.interjection() // 'gah'
faker.word.interjection(5) // 'fooey'
faker.word.interjection(100) // 'yowza'
faker.word.interjection({ strategy: 'shortest' }) // 'hm'
faker.word.interjection({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'boohoo'
Source
noun
Returns a noun of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.noun(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.noun() // 'external'
faker.word.noun(5) // 'front'
faker.word.noun(100) // 'care'
faker.word.noun({ strategy: 'shortest' }) // 'ad'
faker.word.noun({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'average'
Source
preposition
Returns a preposition of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.preposition(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.preposition() // 'without'
faker.word.preposition(5) // 'abaft'
faker.word.preposition(100) // 'an'
faker.word.preposition({ strategy: 'shortest' }) // 'a'
faker.word.preposition({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'given'
Source
sample
Returns a random sample of random or optionally specified length.
Available since v8.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.sample(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.sample() // 'incidentally'
faker.word.sample(5) // 'fruit'
Source
verb
Returns a verb of random or optionally specified length.
Available since v6.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The expected length of the word or the options to use. |
options.length? | number | { max: number, min: number } | The expected length of the word. | |
options.strategy? | 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest' | 'any-length' | The strategy to apply when no words with a matching length are found. Available error handling strategies:
|
Returns: string
faker.word.verb(options: number | {
length: number | {
max: number,
min: number
},
strategy: 'any-length' | 'closest' | 'fail' | 'longest' | 'shortest'
} = {}): string
faker.word.verb() // 'act'
faker.word.verb(5) // 'tinge'
faker.word.verb(100) // 'mess'
faker.word.verb({ strategy: 'shortest' }) // 'do'
faker.word.verb({ length: { min: 5, max: 7 }, strategy: "fail" }) // 'vault'
Source
words
Returns a string containing a number of space separated random words.
Available since v8.0.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | number | { ... } | {} | The optional options object or the number of words to return. |
options.count? | number | { max: number, min: number } | { min: 1, max: 3 } | The number of words to return. |
Returns: string
faker.word.words(options: number | {
count: number | {
max: number,
min: number
}
} = {}): string
faker.word.words() // 'almost'
faker.word.words(5) // 'before hourly patiently dribble equal'
faker.word.words({ count: 5 }) // 'whoever edible um kissingly faraway'
faker.word.words({ count: { min: 5, max: 10 } }) // 'vice buoyant through apropos poised total wary boohoo'