interface-forge - v2.5.0
    Preparing search index...

    Class WordModule

    Module to return various types of words.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    adjective adverb conjunction interjection noun preposition sample verb words

    Constructors

    Properties

    faker: Faker

    Methods

    • Returns a random adjective.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random adverb.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random conjunction.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random interjection.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random noun.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random preposition.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random word, that can be an adjective, adverb, conjunction, interjection, noun, preposition, or verb.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns string

      faker.word.sample() // 'incidentally'
      faker.word.sample(5) // 'fruit'

      8.0.0

    • Returns a random verb.

      Parameters

      • Optionaloptions:
            | number
            | {
                length?: number
                | { max: number; min: number };
                strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
            }

        The expected length of the word or the options to use.

        • number
        • {
              length?: number | { max: number; min: number };
              strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
          }
          • Optionallength?: number | { max: number; min: number }

            The expected length of the word.

          • Optionalstrategy?: "fail" | "closest" | "shortest" | "longest" | "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.
            'any-length'

      Returns 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'

      6.0.0

    • Returns a random string containing some words separated by spaces.

      Parameters

      • Optionaloptions: number | { count?: number | { max: number; min: number } }

        The optional options object or the number of words to return.

        • number
        • { count?: number | { max: number; min: number } }
          • Optionalcount?: number | { max: number; min: number }

            The number of words to return.

            { min: 1, max: 3 }

      Returns 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'

      8.0.0

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods