mini-effect
    Preparing search index...

    Interface SymbolSchema<TMessage>

    Symbol schema interface.

    interface SymbolSchema<TMessage extends ErrorMessage<SymbolIssue> | undefined> {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<symbol, SymbolIssue>;
        "~standard": StandardProps<symbol, symbol>;
        "~types"?: { input: symbol; issue: SymbolIssue; output: symbol };
        async: false;
        expects: "symbol";
        kind: "schema";
        message: TMessage;
        reference: {
            (): SymbolSchema<undefined>;
            <const TMessage extends ErrorMessage<SymbolIssue> | undefined>(
                message: TMessage,
            ): SymbolSchema<TMessage>;
        };
        type: "symbol";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<symbol, SymbolIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<symbol, symbol>

    The Standard Schema properties.

    "~types"?: { input: symbol; issue: SymbolIssue; output: symbol }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "symbol"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        (): SymbolSchema<undefined>;
        <const TMessage extends ErrorMessage<SymbolIssue> | undefined>(
            message: TMessage,
        ): SymbolSchema<TMessage>;
    }

    The schema reference.

    Type Declaration

    type: "symbol"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties