Constraints to be applied on sparseArray

Remarks

Since 2.13.0

Hierarchy

  • SparseArrayConstraints

Properties

depthIdentifier?: string | DepthIdentifier

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?: number

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?: number

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?: number

Lower bound of the number of non-hole elements

Default Value

0

Remarks

Since 2.13.0

noTrailingHole?: boolean

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

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

Remarks

Since 2.22.0

Generated using TypeDoc