mini-effect
    Preparing search index...

    Interface MapSchema<TKey$1, TValue$1, TMessage>

    Map schema interface.

    interface MapSchema<
        TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<MapIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            InferMapOutput<TKey$1, TValue$1>,
            MapIssue | InferIssue<TKey$1> | InferIssue<TValue$1>,
        >;
        "~standard": StandardProps<
            InferMapInput<TKey$1, TValue$1>,
            InferMapOutput<TKey$1, TValue$1>,
        >;
        "~types"?: {
            input: InferMapInput;
            issue: MapIssue | InferIssue<TKey$1> | InferIssue<TValue$1>;
            output: InferMapOutput;
        };
        async: false;
        expects: "Map";
        key: TKey$1;
        kind: "schema";
        message: TMessage;
        reference: {
            <
                const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                key: TKey$1,
                value: TValue$1,
            ): MapSchema<TKey$1, TValue$1, undefined>;
            <
                const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<MapIssue> | undefined,
            >(
                key: TKey$1,
                value: TValue$1,
                message: TMessage,
            ): MapSchema<TKey$1, TValue$1, TMessage>;
        };
        type: "map";
        value: TValue$1;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~standard ~types? async expects key kind message reference type value

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        InferMapOutput<TKey$1, TValue$1>,
        MapIssue | InferIssue<TKey$1> | InferIssue<TValue$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        InferMapInput<TKey$1, TValue$1>,
        InferMapOutput<TKey$1, TValue$1>,
    >

    The Standard Schema properties.

    "~types"?: {
        input: InferMapInput;
        issue: MapIssue | InferIssue<TKey$1> | InferIssue<TValue$1>;
        output: InferMapOutput;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Map"

    The expected property.

    key: TKey$1

    The map key schema.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <
            const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            key: TKey$1,
            value: TValue$1,
        ): MapSchema<TKey$1, TValue$1, undefined>;
        <
            const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<MapIssue> | undefined,
        >(
            key: TKey$1,
            value: TValue$1,
            message: TMessage,
        ): MapSchema<TKey$1, TValue$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <
            const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            key: TKey$1,
            value: TValue$1,
        ): MapSchema<TKey$1, TValue$1, undefined>

      • Creates a map schema.

        Type Parameters

        Parameters

        • key: TKey$1

          The key schema.

        • value: TValue$1

          The value schema.

        Returns MapSchema<TKey$1, TValue$1, undefined>

        A map schema.

      • <
            const TKey$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<MapIssue> | undefined,
        >(
            key: TKey$1,
            value: TValue$1,
            message: TMessage,
        ): MapSchema<TKey$1, TValue$1, TMessage>

      • Creates a map schema.

        Type Parameters

        Parameters

        • key: TKey$1

          The key schema.

        • value: TValue$1

          The value schema.

        • message: TMessage

          The error message.

        Returns MapSchema<TKey$1, TValue$1, TMessage>

        A map schema.

    type: "map"

    The schema type.

    value: TValue$1

    The map value schema.

    Settings

    Member Visibility

    On This Page

    Properties