Interface LoremConstraints

Constraints to be applied on lorem

Remarks

Since 2.5.0

interface LoremConstraints {
    maxCount?: number;
    mode?: "words" | "sentences";
    size?: SizeForArbitrary;
}

Properties

maxCount? mode? size?

Properties

Optional maxCount

maxCount?: number

Maximal number of entities:

  • maximal number of words in case mode is 'words'
  • maximal number of sentences in case mode is 'sentences'

Default Value

0x7fffffff — defaulting seen as "max non specified" when defaultSizeToMaxWhenMaxSpecified=true

Remarks

Since 2.5.0

Optional mode

mode?: "words" | "sentences"

Type of strings that should be produced by lorem:

  • words: multiple words
  • sentences: multiple sentences

Default Value

'words'

Remarks

Since 2.5.0

Optional size

size?: SizeForArbitrary

Define how large the generated values should be (at max)

Remarks

Since 2.22.0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc