Skip to main content

Interface: ObjectConstraints

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:16

Constraints for anything and object

Properties​

depthSize?​

optional depthSize?: DepthSize

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:22

Limit the depth of the object by increasing the probability to generate simple values (defined via values) as we go deeper in the object.

Remarks​

Since 2.20.0

key?​

optional key?: Arbitrary<string>

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:45

Arbitrary for keys

Default Value​

string

Remarks​

Since 0.0.7

maxDepth?​

optional maxDepth?: number

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:28

Maximal depth allowed

Default Value​

Number.POSITIVE_INFINITY — defaulting seen as "max non specified" when defaultSizeToMaxWhenMaxSpecified=true

Remarks​

Since 0.0.7

maxKeys?​

optional maxKeys?: number

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:34

Maximal number of keys

Default Value​

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

Remarks​

Since 1.13.0

size?​

optional size?: SizeForArbitrary

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:39

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

Remarks​

Since 2.22.0

stringUnit?​

optional stringUnit?: "grapheme" | "grapheme-composite" | "grapheme-ascii" | "binary" | "binary-ascii" | Arbitrary<string>

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:120

Replace the default unit for strings.

Default Value​

undefined

Remarks​

Since 3.23.0

values?​

optional values?: Arbitrary<unknown>[]

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:51

Arbitrary for values

Default Value​

boolean, integer, double, string, null, undefined, Number.NaN, +0, -0, Number.EPSILON, Number.MIN_VALUE, Number.MAX_VALUE, Number.MIN_SAFE_INTEGER, Number.MAX_SAFE_INTEGER, Number.POSITIVE_INFINITY, Number.NEGATIVE_INFINITY

Remarks​

Since 0.0.7

withBigInt?​

optional withBigInt?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:87

Also generate BigInt

Default Value​

false

Remarks​

Since 1.26.0

withBoxedValues?​

optional withBoxedValues?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:57

Also generate boxed versions of values

Default Value​

false

Remarks​

Since 1.11.0

withDate?​

optional withDate?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:93

Also generate Date

Default Value​

false

Remarks​

Since 2.5.0

withMap?​

optional withMap?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:69

Also generate Map

Default Value​

false

Remarks​

Since 1.11.0

withNullPrototype?​

optional withNullPrototype?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:81

Also generate object with null prototype

Default Value​

false

Remarks​

Since 1.23.0

withObjectString?​

optional withObjectString?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:75

Also generate string representations of object instances

Default Value​

false

Remarks​

Since 1.17.0

withSet?​

optional withSet?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:63

Also generate Set

Default Value​

false

Remarks​

Since 1.11.0

withSparseArray?​

optional withSparseArray?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:106

Also generate sparse arrays (arrays with holes)

Default Value​

false

Remarks​

Since 2.13.0

withTypedArray?​

optional withTypedArray?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:100

Also generate typed arrays in: (Uint|Int)(8|16|32)Array and Float(32|64)Array Remark: no typed arrays made of bigint

Default Value​

false

Remarks​

Since 2.9.0

withUnicodeString?​

optional withUnicodeString?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/QualifiedObjectConstraints.ts:114

Replace the arbitrary of strings defaulted for key and values by one able to generate unicode strings with non-ascii characters. If you override key and/or values constraint, this flag will not apply to your override.

Deprecated​

Prefer using stringUnit to customize the kind of strings that will be generated by default.

Default Value​

false

Remarks​

Since 3.19.0