mini-effect
    Preparing search index...

    Interface LooseObjectSchemaAsync<TEntries$1, TMessage>

    Object schema async interface.

    interface LooseObjectSchemaAsync<
        TEntries$1 extends ObjectEntriesAsync,
        TMessage extends ErrorMessage<LooseObjectIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<
                {
                    [TKey in string
                    | number
                    | symbol]: OutputWithReadonly<
                        TEntries$1,
                        OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                    >[TKey]
                } & { [key: string]: unknown },
                LooseObjectIssue | InferObjectIssue<TEntries$1>,
            >,
        >;
        "~standard": StandardProps<
            {
                [TKey in string
                | number
                | symbol]: InputWithQuestionMarks<
                    TEntries$1,
                    InferEntriesInput<TEntries$1>,
                >[TKey]
            } & { [key: string]: unknown },
            {
                [TKey in string | number | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            } & { [key: string]: unknown },
        >;
        "~types"?: {
            input: {
                [TKey in string | number | symbol]: InputWithQuestionMarks<
                    TEntries$1,
                    InferEntriesInput<TEntries$1>,
                >[TKey]
            } & { [key: string]: unknown };
            issue: LooseObjectIssue | InferObjectIssue<TEntries$1>;
            output: {
                [TKey in string | number | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            } & { [key: string]: unknown };
        };
        async: true;
        entries: TEntries$1;
        expects: "Object";
        kind: "schema";
        message: TMessage;
        reference: | {
            <const TEntries$1 extends ObjectEntries>(
                entries: TEntries$1,
            ): LooseObjectSchema<TEntries$1, undefined>;
            <
                const TEntries$1 extends ObjectEntries,
                const TMessage extends ErrorMessage<LooseObjectIssue> | undefined,
            >(
                entries: TEntries$1,
                message: TMessage,
            ): LooseObjectSchema<TEntries$1, TMessage>;
        }
        | {
            <const TEntries$1 extends ObjectEntriesAsync>(
                entries: TEntries$1,
            ): LooseObjectSchemaAsync<TEntries$1, undefined>;
            <
                const TEntries$1 extends ObjectEntriesAsync,
                const TMessage extends ErrorMessage<LooseObjectIssue> | undefined,
            >(
                entries: TEntries$1,
                message: TMessage,
            ): LooseObjectSchemaAsync<TEntries$1, TMessage>;
        };
        type: "loose_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>>,
    ) => Promise<
        OutputDataset<
            {
                [TKey in string
                | number
                | symbol]: OutputWithReadonly<
                    TEntries$1,
                    OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                >[TKey]
            } & { [key: string]: unknown },
            LooseObjectIssue | InferObjectIssue<TEntries$1>,
        >,
    >

    Parses unknown input values.

    Type Declaration

      • (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ): Promise<
            OutputDataset<
                {
                    [TKey in string
                    | number
                    | symbol]: OutputWithReadonly<
                        TEntries$1,
                        OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                    >[TKey]
                } & { [key: string]: unknown },
                LooseObjectIssue | InferObjectIssue<TEntries$1>,
            >,
        >

      • Parameters

        Returns Promise<
            OutputDataset<
                {
                    [TKey in string
                    | number
                    | symbol]: OutputWithReadonly<
                        TEntries$1,
                        OutputWithQuestionMarks<TEntries$1, InferEntriesOutput<TEntries$1>>,
                    >[TKey]
                } & { [key: string]: unknown },
                LooseObjectIssue | InferObjectIssue<TEntries$1>,
            >,
        >

        The output dataset.

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

    The Standard Schema properties.

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

    The input, output and issue type.

    async: true

    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,
            ): LooseObjectSchema<TEntries$1, undefined>;
            <
                const TEntries$1 extends ObjectEntries,
                const TMessage extends ErrorMessage<LooseObjectIssue> | undefined,
            >(
                entries: TEntries$1,
                message: TMessage,
            ): LooseObjectSchema<TEntries$1, TMessage>;
        }
        | {
            <const TEntries$1 extends ObjectEntriesAsync>(
                entries: TEntries$1,
            ): LooseObjectSchemaAsync<TEntries$1, undefined>;
            <
                const TEntries$1 extends ObjectEntriesAsync,
                const TMessage extends ErrorMessage<LooseObjectIssue> | undefined,
            >(
                entries: TEntries$1,
                message: TMessage,
            ): LooseObjectSchemaAsync<TEntries$1, TMessage>;
        }

    The schema reference.

    Type Declaration

    type: "loose_object"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties