@eleven-am/faker
    Preparing search index...

    Interface Schema<T>

    interface Schema<T> {
        generate: (
            contextOptions?: Partial<Omit<GeneratorContext, "rng" | "options">> & {
                seed?: number;
            },
        ) => T;
        generateMany: (count: number, options?: { seed?: number }) => T[];
        optional: (probability?: number) => Schema<null | T>;
        pipe: <U>(
            ...transformers: ((val: any, context: GeneratorContext) => any)[],
        ) => Schema<U>;
        transform: <U>(fn: (val: T, context: GeneratorContext) => U) => Schema<U>;
        where: (predicate: (val: T) => boolean, retries?: number) => Schema<T>;
    }

    Type Parameters

    • T

    Implemented by

    Index

    Properties

    generate generateMany optional pipe transform where

    Properties

    generate: (
        contextOptions?: Partial<Omit<GeneratorContext, "rng" | "options">> & {
            seed?: number;
        },
    ) => T

    Generates a single value using the schema.

    generateMany: (count: number, options?: { seed?: number }) => T[]

    Generates an array of values using the schema.

    optional: (probability?: number) => Schema<null | T>

    Makes the generated value potentially null.

    pipe: <U>(
        ...transformers: ((val: any, context: GeneratorContext) => any)[],
    ) => Schema<U>

    Chains multiple transformation functions.

    transform: <U>(fn: (val: T, context: GeneratorContext) => U) => Schema<U>

    Applies a transformation function after generation.

    where: (predicate: (val: T) => boolean, retries?: number) => Schema<T>

    Adds a constraint that the generated value must satisfy. Retries generation up to retries times if the predicate fails.

    Settings

    Member Visibility

    On This Page

    Properties