mini-effect
    Preparing search index...

    Interface NonNullishSchema<TWrapped$1, TMessage>

    Non nullish schema interface.

    interface NonNullishSchema<
        TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<NonNullishIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            NonNullish<InferOutput<TWrapped$1>>,
            NonNullishIssue | InferNonNullishIssue<TWrapped$1>,
        >;
        "~standard": StandardProps<
            NonNullish<InferInput<TWrapped$1>>,
            NonNullish<InferOutput<TWrapped$1>>,
        >;
        "~types"?: {
            input: NonNullish;
            issue: NonNullishIssue | InferNonNullishIssue<TWrapped$1>;
            output: NonNullish;
        };
        async: false;
        expects: "(!null & !undefined)";
        kind: "schema";
        message: TMessage;
        reference: {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NonNullishSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<NonNullishIssue>
                | undefined,
            >(
                wrapped: TWrapped$1,
                message: TMessage,
            ): NonNullishSchema<TWrapped$1, TMessage>;
        };
        type: "non_nullish";
        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>>,
    ) => OutputDataset<
        NonNullish<InferOutput<TWrapped$1>>,
        NonNullishIssue | InferNonNullishIssue<TWrapped$1>,
    >

    Parses unknown input values.

    Type Declaration

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

    The Standard Schema properties.

    "~types"?: {
        input: NonNullish;
        issue: NonNullishIssue | InferNonNullishIssue<TWrapped$1>;
        output: NonNullish;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "(!null & !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,
        ): NonNullishSchema<TWrapped$1, undefined>;
        <
            const TWrapped$1 extends
                BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<NonNullishIssue>
            | undefined,
        >(
            wrapped: TWrapped$1,
            message: TMessage,
        ): NonNullishSchema<TWrapped$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
            wrapped: TWrapped$1,
        ): NonNullishSchema<TWrapped$1, undefined>

      • Creates a non nullish schema.

        Type Parameters

        Parameters

        • wrapped: TWrapped$1

          The wrapped schema.

        Returns NonNullishSchema<TWrapped$1, undefined>

        A non nullish schema.

      • <
            const TWrapped$1 extends
                BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<NonNullishIssue>
            | undefined,
        >(
            wrapped: TWrapped$1,
            message: TMessage,
        ): NonNullishSchema<TWrapped$1, TMessage>

      • Creates a non nullish schema.

        Type Parameters

        Parameters

        • wrapped: TWrapped$1

          The wrapped schema.

        • message: TMessage

          The error message.

        Returns NonNullishSchema<TWrapped$1, TMessage>

        A non nullish schema.

    type: "non_nullish"

    The schema type.

    wrapped: TWrapped$1

    The wrapped schema.

    Settings

    Member Visibility

    On This Page

    Properties