mini-effect
    Preparing search index...

    Interface ObjectSchema<TEntries$1, TMessage>

    Object schema interface.

    interface ObjectSchema<
        TEntries$1 extends ObjectEntries,
        TMessage extends ErrorMessage<ObjectIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            {
                [TKey in string
                | number
                | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            },
            ObjectIssue
            | InferObjectIssue<TEntries$1>,
        >;
        "~standard": StandardProps<
            {
                [TKey in string
                | number
                | symbol]: InputWithQuestionMarks<
                    TEntries$1,
                    InferEntriesInput<TEntries$1>,
                >[TKey]
            },
            {
                [TKey in string
                | number
                | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            },
        >;
        "~types"?: {
            input: {
                [TKey in string
                | number
                | symbol]: InputWithQuestionMarks<
                    TEntries$1,
                    InferEntriesInput<TEntries$1>,
                >[TKey]
            };
            issue: ObjectIssue
            | InferObjectIssue<TEntries$1>;
            output: {
                [TKey in string | number | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            };
        };
        async: false;
        entries: TEntries$1;
        expects: "Object";
        kind: "schema";
        message: TMessage;
        reference: {
            <const TEntries$1 extends ObjectEntries>(
                entries: TEntries$1,
            ): ObjectSchema<TEntries$1, undefined>;
            <
                const TEntries$1 extends ObjectEntries,
                const TMessage extends ErrorMessage<ObjectIssue> | undefined,
            >(
                entries: TEntries$1,
                message: TMessage,
            ): ObjectSchema<TEntries$1, TMessage>;
        };
        type: "object";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        {
            [TKey in string
            | number
            | symbol]: OutputWithReadonly<
                TEntries$1,
                OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
            >[TKey]
        },
        ObjectIssue
        | InferObjectIssue<TEntries$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        {
            [TKey in string
            | number
            | symbol]: InputWithQuestionMarks<
                TEntries$1,
                InferEntriesInput<TEntries$1>,
            >[TKey]
        },
        {
            [TKey in string
            | number
            | symbol]: OutputWithReadonly<
                TEntries$1,
                OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
            >[TKey]
        },
    >

    The Standard Schema properties.

    "~types"?: {
        input: {
            [TKey in string | number | symbol]: InputWithQuestionMarks<
                TEntries$1,
                InferEntriesInput<TEntries$1>,
            >[TKey]
        };
        issue: ObjectIssue
        | InferObjectIssue<TEntries$1>;
        output: {
            [TKey in string | number | symbol]: OutputWithReadonly<
                TEntries$1,
                OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
            >[TKey]
        };
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    entries: TEntries$1

    The entries schema.

    expects: "Object"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <const TEntries$1 extends ObjectEntries>(
            entries: TEntries$1,
        ): ObjectSchema<TEntries$1, undefined>;
        <
            const TEntries$1 extends ObjectEntries,
            const TMessage extends ErrorMessage<ObjectIssue> | undefined,
        >(
            entries: TEntries$1,
            message: TMessage,
        ): ObjectSchema<TEntries$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <const TEntries$1 extends ObjectEntries>(
            entries: TEntries$1,
        ): ObjectSchema<TEntries$1, undefined>

      • Creates an object schema.

        Hint: This schema removes unknown entries. The output will only include the entries you specify. To include unknown entries, use looseObject. To return an issue for unknown entries, use strictObject. To include and validate unknown entries, use objectWithRest.

        Type Parameters

        Parameters

        • entries: TEntries$1

          The entries schema.

        Returns ObjectSchema<TEntries$1, undefined>

        An object schema.

      • <
            const TEntries$1 extends ObjectEntries,
            const TMessage extends ErrorMessage<ObjectIssue> | undefined,
        >(
            entries: TEntries$1,
            message: TMessage,
        ): ObjectSchema<TEntries$1, TMessage>

      • Creates an object schema.

        Hint: This schema removes unknown entries. The output will only include the entries you specify. To include unknown entries, use looseObject. To return an issue for unknown entries, use strictObject. To include and validate unknown entries, use objectWithRest.

        Type Parameters

        Parameters

        • entries: TEntries$1

          The entries schema.

        • message: TMessage

          The error message.

        Returns ObjectSchema<TEntries$1, TMessage>

        An object schema.

    type: "object"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties