mini-effect
    Preparing search index...

    Interface InstanceSchema<TClass, TMessage>

    Instance schema interface.

    interface InstanceSchema<
        TClass extends Class,
        TMessage extends ErrorMessage<InstanceIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<InstanceType<TClass>, InstanceIssue>;
        "~standard": StandardProps<InstanceType<TClass>, InstanceType<TClass>>;
        "~types"?: {
            input: InstanceType;
            issue: InstanceIssue;
            output: InstanceType;
        };
        async: false;
        class: TClass;
        expects: string;
        kind: "schema";
        message: TMessage;
        reference: {
            <TClass extends Class>(
                class_: TClass,
            ): InstanceSchema<TClass, undefined>;
            <
                TClass extends Class,
                const TMessage extends ErrorMessage<InstanceIssue> | undefined,
            >(
                class_: TClass,
                message: TMessage,
            ): InstanceSchema<TClass, TMessage>;
        };
        type: "instance";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<InstanceType<TClass>, InstanceIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<InstanceType<TClass>, InstanceType<TClass>>

    The Standard Schema properties.

    "~types"?: { input: InstanceType; issue: InstanceIssue; output: InstanceType }

    The input, output and issue type.

    async: false

    Whether it's async.

    class: TClass

    The class of the instance.

    expects: string

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TClass extends Class>(
            class_: TClass,
        ): InstanceSchema<TClass, undefined>;
        <
            TClass extends Class,
            const TMessage extends ErrorMessage<InstanceIssue> | undefined,
        >(
            class_: TClass,
            message: TMessage,
        ): InstanceSchema<TClass, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <TClass extends Class>(class_: TClass): InstanceSchema<TClass, undefined>

      • Creates an instance schema.

        Type Parameters

        Parameters

        • class_: TClass

          The class of the instance.

        Returns InstanceSchema<TClass, undefined>

        An instance schema.

      • <
            TClass extends Class,
            const TMessage extends ErrorMessage<InstanceIssue> | undefined,
        >(
            class_: TClass,
            message: TMessage,
        ): InstanceSchema<TClass, TMessage>

      • Creates an instance schema.

        Type Parameters

        Parameters

        • class_: TClass

          The class of the instance.

        • message: TMessage

          The error message.

        Returns InstanceSchema<TClass, TMessage>

        An instance schema.

    type: "instance"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties