mini-effect
    Preparing search index...

    Interface FileSchema<TMessage>

    File schema interface.

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

    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<File, FileIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<File, File>

    The Standard Schema properties.

    "~types"?: { input: File; issue: FileIssue; output: File }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "File"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

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

    The schema reference.

    Type Declaration

    type: "file"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties