Skip to main content

Interface: ArrayConstraints

Defined in: packages/fast-check/src/arbitrary/array.ts:15

Constraints to be applied on array

Remarks​

Since 2.4.0

Properties​

depthIdentifier?​

optional depthIdentifier?: string | DepthIdentifier

Defined in: packages/fast-check/src/arbitrary/array.ts:51

When receiving a depth identifier, the arbitrary will impact the depth attached to it to avoid going too deep if it already generated lots of items.

In other words, if the number of generated values within the collection is large then the generated items will tend to be less deep to avoid creating structures a lot larger than expected.

For the moment, the depth is not taken into account to compute the number of items to define for a precise generate call of the array. Just applied onto eligible items.

Remarks​

Since 2.25.0

maxLength?​

optional maxLength?: number

Defined in: packages/fast-check/src/arbitrary/array.ts:27

Upper bound of the generated array size

Default Value​

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

Remarks​

Since 2.4.0

minLength?​

optional minLength?: number

Defined in: packages/fast-check/src/arbitrary/array.ts:21

Lower bound of the generated array size

Default Value​

0

Remarks​

Since 2.4.0

size?​

optional size?: SizeForArbitrary

Defined in: packages/fast-check/src/arbitrary/array.ts:37

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

When used in conjonction with maxLength, size will be used to define the upper bound of the generated array size while maxLength will be used to define and document the general maximal length allowed for this case.

Remarks​

Since 2.22.0