Skip to content

Arbitrary

5 exports Added in v3.10.0 Source

Annotations

ArbitraryAnnotation type

Added in v3.10.0 Source

Signature

type ArbitraryAnnotation<A, TypeParameters extends ReadonlyArray<any> = readonly []> = (
  ...arbitraries: [
    ...{ [K in keyof TypeParameters]: LazyArbitrary<TypeParameters[K]> },
    ctx: ArbitraryGenerationContext,
  ]
) => LazyArbitrary<A>;

ArbitraryGenerationContext interface

Added in v3.10.0 Source

Signature

interface ArbitraryGenerationContext {
  readonly constraints?:
    | StringConstraints
    | NumberConstraints
    | BigIntConstraints
    | DateConstraints
    | ArrayConstraints;
  readonly depthIdentifier?: string;
  readonly maxDepth: number;
}

Arbitrary

make

Added in v3.10.0 Source

Returns a fast-check Arbitrary for the A type of the provided schema.

Signature

declare function make<A, I, R>(schema: Schema<A, I, R>): Arbitrary<A>;

makeLazy

Added in v3.10.0 Source

Returns a LazyArbitrary for the A type of the provided schema.

Signature

declare function makeLazy<A, I, R>(schema: Schema<A, I, R>): LazyArbitrary<A>;

Model

LazyArbitrary interface

Added in v3.10.0 Source

Signature

interface LazyArbitrary<A> {
  (fc: __module): Arbitrary<A>;
}