Skip to main content

Type Alias: SetConstraints

SetConstraints = object

Defined in: packages/fast-check/src/arbitrary/set.ts:12

Constraints to be applied on set

Remarks

Since 4.4.0

Properties

depthIdentifier?

optional depthIdentifier?: DepthIdentifier | string

Defined in: packages/fast-check/src/arbitrary/set.ts:43

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 set. Just applied onto eligible items.

Remarks

Since 4.4.0


maxLength?

optional maxLength?: number

Defined in: packages/fast-check/src/arbitrary/set.ts:24

Upper bound of the generated set size

Default Value

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

Remarks

Since 4.4.0


minLength?

optional minLength?: number

Defined in: packages/fast-check/src/arbitrary/set.ts:18

Lower bound of the generated set size

Default Value

0

Remarks

Since 4.4.0


size?

optional size?: SizeForArbitrary

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

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

Remarks

Since 4.4.0