Interface DictionaryConstraints

Constraints to be applied on dictionary

Remarks

Since 2.22.0

interface DictionaryConstraints {
    depthIdentifier?: string | DepthIdentifier;
    maxKeys?: number;
    minKeys?: number;
    noNullPrototype?: boolean;
    size?: SizeForArbitrary;
}

Properties

depthIdentifier? maxKeys? minKeys? noNullPrototype? size?

Properties

Optional depthIdentifier

depthIdentifier?: string | DepthIdentifier

Depth identifier can be used to share the current depth between several instances.

By default, if not specified, each instance of dictionary will have its own depth. In other words: you can have depth=1 in one while you have depth=100 in another one.

Remarks

Since 3.15.0

Optional maxKeys

maxKeys?: number

Lower bound for the number of keys defined into the generated instance

Default Value

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

Remarks

Since 2.22.0

Optional minKeys

minKeys?: number

Lower bound for the number of keys defined into the generated instance

Default Value

0

Remarks

Since 2.22.0

Optional noNullPrototype

noNullPrototype?: boolean

Do not generate objects with null prototype

Default Value

true

Remarks

Since 3.13.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

depthIdentifiermaxKeysminKeysnoNullPrototypesize