mini-effect
    Preparing search index...

    Interface TupleSchema<TItems$1, TMessage>

    Tuple schema interface.

    interface TupleSchema<
        TItems$1 extends TupleItems,
        TMessage extends ErrorMessage<TupleIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            InferTupleOutput<TItems$1>,
            TupleIssue | InferTupleIssue<TItems$1>,
        >;
        "~standard": StandardProps<
            InferTupleInput<TItems$1>,
            InferTupleOutput<TItems$1>,
        >;
        "~types"?: {
            input: TInput$1;
            issue: TupleIssue | InferTupleIssue<TItems$1>;
            output: TOutput$1;
        };
        async: false;
        expects: "Array";
        items: TItems$1;
        kind: "schema";
        message: TMessage;
        reference: {
            <const TItems$1 extends TupleItems>(
                items: TItems$1,
            ): TupleSchema<TItems$1, undefined>;
            <
                const TItems$1 extends TupleItems,
                const TMessage extends ErrorMessage<TupleIssue> | undefined,
            >(
                items: TItems$1,
                message: TMessage,
            ): TupleSchema<TItems$1, TMessage>;
        };
        type: "tuple";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        InferTupleOutput<TItems$1>,
        TupleIssue | InferTupleIssue<TItems$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        InferTupleInput<TItems$1>,
        InferTupleOutput<TItems$1>,
    >

    The Standard Schema properties.

    "~types"?: {
        input: TInput$1;
        issue: TupleIssue | InferTupleIssue<TItems$1>;
        output: TOutput$1;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Array"

    The expected property.

    items: TItems$1

    The items schema.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <const TItems$1 extends TupleItems>(
            items: TItems$1,
        ): TupleSchema<TItems$1, undefined>;
        <
            const TItems$1 extends TupleItems,
            const TMessage extends ErrorMessage<TupleIssue> | undefined,
        >(
            items: TItems$1,
            message: TMessage,
        ): TupleSchema<TItems$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <const TItems$1 extends TupleItems>(
            items: TItems$1,
        ): TupleSchema<TItems$1, undefined>

      • Creates a tuple schema.

        Hint: This schema removes unknown items. The output will only include the items you specify. To include unknown items, use looseTuple. To return an issue for unknown items, use strictTuple. To include and validate unknown items, use tupleWithRest.

        Type Parameters

        Parameters

        • items: TItems$1

          The items schema.

        Returns TupleSchema<TItems$1, undefined>

        A tuple schema.

      • <
            const TItems$1 extends TupleItems,
            const TMessage extends ErrorMessage<TupleIssue> | undefined,
        >(
            items: TItems$1,
            message: TMessage,
        ): TupleSchema<TItems$1, TMessage>

      • Creates a tuple schema.

        Hint: This schema removes unknown items. The output will only include the items you specify. To include unknown items, use looseTuple. To return an issue for unknown items, use strictTuple. To include and validate unknown items, use tupleWithRest.

        Type Parameters

        Parameters

        • items: TItems$1

          The items schema.

        • message: TMessage

          The error message.

        Returns TupleSchema<TItems$1, TMessage>

        A tuple schema.

    type: "tuple"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties