mini-effect
    Preparing search index...

    Interface ArraySchema<TItem$1, TMessage>

    Array schema interface.

    interface ArraySchema<
        TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<ArrayIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            InferOutput<TItem$1>[],
            ArrayIssue | InferIssue<TItem$1>,
        >;
        "~standard": StandardProps<InferInput<TItem$1>[], InferOutput<TItem$1>[]>;
        "~types"?: {
            input: InferInput<TItem$1>[];
            issue: ArrayIssue | InferIssue<TItem$1>;
            output: InferOutput<TItem$1>[];
        };
        async: false;
        expects: "Array";
        item: TItem$1;
        kind: "schema";
        message: TMessage;
        reference: {
            <
                const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                item: TItem$1,
            ): ArraySchema<TItem$1, undefined>;
            <
                const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<ArrayIssue> | undefined,
            >(
                item: TItem$1,
                message: TMessage,
            ): ArraySchema<TItem$1, TMessage>;
        };
        type: "array";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<InferOutput<TItem$1>[], ArrayIssue | InferIssue<TItem$1>>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<InferInput<TItem$1>[], InferOutput<TItem$1>[]>

    The Standard Schema properties.

    "~types"?: {
        input: InferInput<TItem$1>[];
        issue: ArrayIssue | InferIssue<TItem$1>;
        output: InferOutput<TItem$1>[];
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Array"

    The expected property.

    item: TItem$1

    The array item schema.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
            item: TItem$1,
        ): ArraySchema<TItem$1, undefined>;
        <
            const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<ArrayIssue> | undefined,
        >(
            item: TItem$1,
            message: TMessage,
        ): ArraySchema<TItem$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
            item: TItem$1,
        ): ArraySchema<TItem$1, undefined>

      • Creates an array schema.

        Type Parameters

        Parameters

        • item: TItem$1

          The item schema.

        Returns ArraySchema<TItem$1, undefined>

        An array schema.

      • <
            const TItem$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<ArrayIssue> | undefined,
        >(
            item: TItem$1,
            message: TMessage,
        ): ArraySchema<TItem$1, TMessage>

      • Creates an array schema.

        Type Parameters

        Parameters

        • item: TItem$1

          The item schema.

        • message: TMessage

          The error message.

        Returns ArraySchema<TItem$1, TMessage>

        An array schema.

    type: "array"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties