mini-effect
    Preparing search index...

    Interface NonOptionalSchemaAsync<TWrapped$1, TMessage>

    Non optional schema async interface.

    interface NonOptionalSchemaAsync<
        TWrapped$1 extends
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<NonOptionalIssue>
        | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<
                NonOptional<InferOutput<TWrapped$1>>,
                NonOptionalIssue | InferNonOptionalIssue<TWrapped$1>,
            >,
        >;
        "~standard": StandardProps<
            NonOptional<InferInput<TWrapped$1>>,
            NonOptional<InferOutput<TWrapped$1>>,
        >;
        "~types"?: {
            input: NonOptional;
            issue: NonOptionalIssue | InferNonOptionalIssue<TWrapped$1>;
            output: NonOptional;
        };
        async: true;
        expects: "!undefined";
        kind: "schema";
        message: TMessage;
        reference: | {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NonOptionalSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<NonOptionalIssue>
                | undefined,
            >(
                wrapped: TWrapped$1,
                message: TMessage,
            ): NonOptionalSchema<TWrapped$1, TMessage>;
        }
        | {
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NonOptionalSchemaAsync<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<NonOptionalIssue>
                | undefined,
            >(
                wrapped: TWrapped$1,
                message: TMessage,
            ): NonOptionalSchemaAsync<TWrapped$1, TMessage>;
        };
        type: "non_optional";
        wrapped: TWrapped$1;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<
        OutputDataset<
            NonOptional<InferOutput<TWrapped$1>>,
            NonOptionalIssue | InferNonOptionalIssue<TWrapped$1>,
        >,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        NonOptional<InferInput<TWrapped$1>>,
        NonOptional<InferOutput<TWrapped$1>>,
    >

    The Standard Schema properties.

    "~types"?: {
        input: NonOptional;
        issue: NonOptionalIssue | InferNonOptionalIssue<TWrapped$1>;
        output: NonOptional;
    }

    The input, output and issue type.

    async: true

    Whether it's async.

    expects: "!undefined"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference:
        | {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NonOptionalSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<NonOptionalIssue>
                | undefined,
            >(
                wrapped: TWrapped$1,
                message: TMessage,
            ): NonOptionalSchema<TWrapped$1, TMessage>;
        }
        | {
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NonOptionalSchemaAsync<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<NonOptionalIssue>
                | undefined,
            >(
                wrapped: TWrapped$1,
                message: TMessage,
            ): NonOptionalSchemaAsync<TWrapped$1, TMessage>;
        }

    The schema reference.

    Type Declaration

    type: "non_optional"

    The schema type.

    wrapped: TWrapped$1

    The wrapped schema.

    Settings

    Member Visibility

    On This Page

    Properties