mini-effect
    Preparing search index...

    Interface NullableSchema<TWrapped$1, TDefault>

    Nullable schema interface.

    interface NullableSchema<
        TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TDefault extends Default<TWrapped$1, null>,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            InferNullableOutput<TWrapped$1, TDefault>,
            InferIssue<TWrapped$1>,
        >;
        "~standard": StandardProps<
            InferInput<TWrapped$1>
            | null,
            InferNullableOutput<TWrapped$1, TDefault>,
        >;
        "~types"?: {
            input: InferInput<TWrapped$1> | null;
            issue: InferIssue;
            output: InferNullableOutput;
        };
        async: false;
        default: TDefault;
        expects: `(${TWrapped$1["expects"]} | null)`;
        kind: "schema";
        reference: {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): NullableSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): NullableSchema<TWrapped$1, TDefault>;
        };
        type: "nullable";
        wrapped: TWrapped$1;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        InferNullableOutput<TWrapped$1, TDefault>,
        InferIssue<TWrapped$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        InferInput<TWrapped$1>
        | null,
        InferNullableOutput<TWrapped$1, TDefault>,
    >

    The Standard Schema properties.

    "~types"?: {
        input: InferInput<TWrapped$1> | null;
        issue: InferIssue;
        output: InferNullableOutput;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    default: TDefault

    The default value.

    expects: `(${TWrapped$1["expects"]} | null)`

    The expected property.

    kind: "schema"

    The object kind.

    reference: {
        <
            const TWrapped$1 extends
                BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            wrapped: TWrapped$1,
        ): NullableSchema<TWrapped$1, undefined>;
        <
            const TWrapped$1 extends
                BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TDefault extends unknown,
        >(
            wrapped: TWrapped$1,
            default_: TDefault,
        ): NullableSchema<TWrapped$1, TDefault>;
    }

    The schema reference.

    Type Declaration

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

      • Creates a nullable schema.

        Type Parameters

        Parameters

        • wrapped: TWrapped$1

          The wrapped schema.

        Returns NullableSchema<TWrapped$1, undefined>

        A nullable schema.

      • <
            const TWrapped$1 extends
                BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TDefault extends unknown,
        >(
            wrapped: TWrapped$1,
            default_: TDefault,
        ): NullableSchema<TWrapped$1, TDefault>

      • Creates a nullable schema.

        Type Parameters

        • const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
        • const TDefault extends unknown

        Parameters

        • wrapped: TWrapped$1

          The wrapped schema.

        • default_: TDefault

          The default value.

        Returns NullableSchema<TWrapped$1, TDefault>

        A nullable schema.

    type: "nullable"

    The schema type.

    wrapped: TWrapped$1

    The wrapped schema.

    Settings

    Member Visibility

    On This Page

    Properties