Skip to main content

Function: object()

Call Signature

object(): Arbitrary<Record<string, unknown>>

Defined in: packages/fast-check/src/arbitrary/object.ts:31

For any objects

You may use sample to preview the values that will be generated

Returns

Arbitrary<Record<string, unknown>>

Example

{}, {k: [{}, 1, 2]}

Remarks

Since 0.0.7

Call Signature

object(constraints): Arbitrary<Record<string, unknown>>

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

For any objects following the constraints defined by settings

You may use sample to preview the values that will be generated

Parameters

ParameterTypeDescription
constraintsObjectConstraintsConstraints to apply when building instances

Returns

Arbitrary<Record<string, unknown>>

Example

{}, {k: [{}, 1, 2]}

Remarks

Since 0.0.7