mini-effect
    Preparing search index...

    Interface BaseSchemaAsync<TInput$1, TOutput$1, TIssue>

    Base schema async interface.

    interface BaseSchemaAsync<
        TInput$1,
        TOutput$1,
        TIssue extends BaseIssue<unknown>,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<OutputDataset<TOutput$1, TIssue>>;
        "~standard": StandardProps<TInput$1, TOutput$1>;
        "~types"?: { input: TInput$1; issue: TIssue; output: TOutput$1 };
        async: true;
        expects: string;
        kind: "schema";
        reference: (
            ...args: any[],
        ) =>
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>;
        type: string;
    }

    Type Parameters

    • TInput$1
    • TOutput$1
    • TIssue extends BaseIssue<unknown>

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~standard ~types? async expects kind reference type

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<OutputDataset<TOutput$1, TIssue>>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<TInput$1, TOutput$1>

    The Standard Schema properties.

    "~types"?: { input: TInput$1; issue: TIssue; output: TOutput$1 }

    The input, output and issue type.

    async: true

    Whether it's async.

    expects: string

    The expected property.

    kind: "schema"

    The object kind.

    reference: (
        ...args: any[],
    ) =>
        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
        | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>

    The schema reference.

    type: string

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties