Skip to main content

Interface: DictionaryConstraints

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:23

Constraints to be applied on dictionary

Remarks​

Since 2.22.0

Properties​

depthIdentifier?​

optional depthIdentifier?: string | DepthIdentifier

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:49

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

maxKeys?​

optional maxKeys?: number

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:35

Upper 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

minKeys?​

optional minKeys?: number

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:29

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

Default Value​

0

Remarks​

Since 2.22.0

noNullPrototype?​

optional noNullPrototype?: boolean

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:55

Do not generate objects with null prototype

Default Value​

false

Remarks​

Since 3.13.0

size?​

optional size?: SizeForArbitrary

Defined in: packages/fast-check/src/arbitrary/dictionary.ts:40

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

Remarks​

Since 2.22.0