Skip to main content

Interface: SparseArrayConstraints

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

Constraints to be applied on sparseArray

Remarks​

Since 2.13.0

Properties​

depthIdentifier?​

optional depthIdentifier?: string | DepthIdentifier

Defined in: packages/fast-check/src/arbitrary/sparseArray.ts:66

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/sparseArray.ts:29

Upper bound of the generated array size (maximal size: 4294967295)

Default Value​

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

Remarks​

Since 2.13.0

maxNumElements?​

optional maxNumElements?: number

Defined in: packages/fast-check/src/arbitrary/sparseArray.ts:41

Upper bound of the number of non-hole elements

Default Value​

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

Remarks​

Since 2.13.0

minNumElements?​

optional minNumElements?: number

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

Lower bound of the number of non-hole elements

Default Value​

0

Remarks​

Since 2.13.0

noTrailingHole?​

optional noTrailingHole?: boolean

Defined in: packages/fast-check/src/arbitrary/sparseArray.ts:47

When enabled, all generated arrays will either be the empty array or end by a non-hole

Default Value​

false

Remarks​

Since 2.13.0

size?​

optional size?: SizeForArbitrary

Defined in: packages/fast-check/src/arbitrary/sparseArray.ts:52

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

Remarks​

Since 2.22.0