mini-effect
    Preparing search index...

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

    Record schema interface.

    interface RecordSchema<
        TKey$1 extends
            BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
        TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<RecordIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            {
                [TKey in string
                | number
                | symbol]: WithReadonly<
                    TValue$1,
                    WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
                >[TKey]
            },
            RecordIssue
            | InferIssue<TKey$1>
            | InferIssue<TValue$1>,
        >;
        "~standard": StandardProps<
            {
                [TKey in string]: WithQuestionMarks<
                    Record<InferInput<TKey$1>, InferInput<TValue$1>>,
                >[TKey]
            },
            {
                [TKey in string
                | number
                | symbol]: WithReadonly<
                    TValue$1,
                    WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
                >[TKey]
            },
        >;
        "~types"?: {
            input: {
                [TKey in string]: WithQuestionMarks<
                    Record<InferInput<TKey$1>, InferInput<TValue$1>>,
                >[TKey]
            };
            issue: RecordIssue
            | InferIssue<TKey$1>
            | InferIssue<TValue$1>;
            output: {
                [TKey in string | number | symbol]: WithReadonly<
                    TValue$1,
                    WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
                >[TKey]
            };
        };
        async: false;
        expects: "Object";
        key: TKey$1;
        kind: "schema";
        message: TMessage;
        reference: {
            <
                const TKey$1 extends
                    BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
                const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                key: TKey$1,
                value: TValue$1,
            ): RecordSchema<TKey$1, TValue$1, undefined>;
            <
                const TKey$1 extends
                    BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
                const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<RecordIssue> | undefined,
            >(
                key: TKey$1,
                value: TValue$1,
                message: TMessage,
            ): RecordSchema<TKey$1, TValue$1, TMessage>;
        };
        type: "record";
        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<
        {
            [TKey in string
            | number
            | symbol]: WithReadonly<
                TValue$1,
                WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
            >[TKey]
        },
        RecordIssue
        | InferIssue<TKey$1>
        | InferIssue<TValue$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        {
            [TKey in string]: WithQuestionMarks<
                Record<InferInput<TKey$1>, InferInput<TValue$1>>,
            >[TKey]
        },
        {
            [TKey in string
            | number
            | symbol]: WithReadonly<
                TValue$1,
                WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
            >[TKey]
        },
    >

    The Standard Schema properties.

    "~types"?: {
        input: {
            [TKey in string]: WithQuestionMarks<
                Record<InferInput<TKey$1>, InferInput<TValue$1>>,
            >[TKey]
        };
        issue: RecordIssue
        | InferIssue<TKey$1>
        | InferIssue<TValue$1>;
        output: {
            [TKey in string | number | symbol]: WithReadonly<
                TValue$1,
                WithQuestionMarks<Record<InferOutput<TKey$1>, InferOutput<TValue$1>>>,
            >[TKey]
        };
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Object"

    The expected property.

    key: TKey$1

    The record key schema.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <
            const TKey$1 extends
                BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            key: TKey$1,
            value: TValue$1,
        ): RecordSchema<TKey$1, TValue$1, undefined>;
        <
            const TKey$1 extends
                BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<RecordIssue> | undefined,
        >(
            key: TKey$1,
            value: TValue$1,
            message: TMessage,
        ): RecordSchema<TKey$1, TValue$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <
            const TKey$1 extends
                BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            key: TKey$1,
            value: TValue$1,
        ): RecordSchema<TKey$1, TValue$1, undefined>

      • Creates a record schema.

        Type Parameters

        Parameters

        • key: TKey$1

          The key schema.

        • value: TValue$1

          The value schema.

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

        A record schema.

      • <
            const TKey$1 extends
                BaseSchema<string, string | number | symbol, BaseIssue<unknown>>,
            const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<RecordIssue> | undefined,
        >(
            key: TKey$1,
            value: TValue$1,
            message: TMessage,
        ): RecordSchema<TKey$1, TValue$1, TMessage>

      • Creates a record schema.

        Type Parameters

        Parameters

        • key: TKey$1

          The key schema.

        • value: TValue$1

          The value schema.

        • message: TMessage

          The error message.

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

        A record schema.

    type: "record"

    The schema type.

    value: TValue$1

    The record value schema.

    Settings

    Member Visibility

    On This Page

    Properties