mini-effect
    Preparing search index...

    Interface HashAction<TInput$1, TMessage>

    Hash action interface.

    interface HashAction<
        TInput$1 extends string,
        TMessage extends ErrorMessage<HashIssue<TInput$1>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<TInput$1, BaseIssue<unknown> | HashIssue<TInput$1>>;
        "~types"?: { input: TInput$1; issue: HashIssue; output: TInput$1 };
        async: false;
        expects: null;
        kind: "validation";
        message: TMessage;
        reference: {
            <TInput$1 extends string>(
                types: [
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32",
                    ...(
                        | "md4"
                        | "md5"
                        | "sha1"
                        | "sha256"
                        | "sha384"
                        | "sha512"
                        | "ripemd128"
                        | "ripemd160"
                        | "tiger128"
                        | "tiger160"
                        | "tiger192"
                        | "crc32"
                        | "crc32b"
                        | "adler32"
                    )[],
                ],
            ): HashAction<TInput$1, undefined>;
            <
                TInput$1 extends string,
                const TMessage extends ErrorMessage<HashIssue<TInput$1>> | undefined,
            >(
                types: [
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32",
                    ...(
                        | "md4"
                        | "md5"
                        | "sha1"
                        | "sha256"
                        | "sha384"
                        | "sha512"
                        | "ripemd128"
                        | "ripemd160"
                        | "tiger128"
                        | "tiger160"
                        | "tiger192"
                        | "crc32"
                        | "crc32b"
                        | "adler32"
                    )[],
                ],
                message: TMessage,
            ): HashAction<TInput$1, TMessage>;
        };
        requirement: RegExp;
        type: "hash";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TInput$1, BaseIssue<unknown> | HashIssue<TInput$1>>

    Validates known input values.

    Type Declaration

    "~types"?: { input: TInput$1; issue: HashIssue; output: TInput$1 }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: null

    The expected property.

    kind: "validation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1 extends string>(
            types: [
                | "md4"
                | "md5"
                | "sha1"
                | "sha256"
                | "sha384"
                | "sha512"
                | "ripemd128"
                | "ripemd160"
                | "tiger128"
                | "tiger160"
                | "tiger192"
                | "crc32"
                | "crc32b"
                | "adler32",
                ...(
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32"
                )[],
            ],
        ): HashAction<TInput$1, undefined>;
        <
            TInput$1 extends string,
            const TMessage extends ErrorMessage<HashIssue<TInput$1>> | undefined,
        >(
            types: [
                | "md4"
                | "md5"
                | "sha1"
                | "sha256"
                | "sha384"
                | "sha512"
                | "ripemd128"
                | "ripemd160"
                | "tiger128"
                | "tiger160"
                | "tiger192"
                | "crc32"
                | "crc32b"
                | "adler32",
                ...(
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32"
                )[],
            ],
            message: TMessage,
        ): HashAction<TInput$1, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1 extends string>(
            types: [
                | "md4"
                | "md5"
                | "sha1"
                | "sha256"
                | "sha384"
                | "sha512"
                | "ripemd128"
                | "ripemd160"
                | "tiger128"
                | "tiger160"
                | "tiger192"
                | "crc32"
                | "crc32b"
                | "adler32",
                ...(
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32"
                )[],
            ],
        ): HashAction<TInput$1, undefined>

      • Creates a hash validation action.

        Type Parameters

        • TInput$1 extends string

        Parameters

        • types: [
              | "md4"
              | "md5"
              | "sha1"
              | "sha256"
              | "sha384"
              | "sha512"
              | "ripemd128"
              | "ripemd160"
              | "tiger128"
              | "tiger160"
              | "tiger192"
              | "crc32"
              | "crc32b"
              | "adler32",
              ...(
                  | "md4"
                  | "md5"
                  | "sha1"
                  | "sha256"
                  | "sha384"
                  | "sha512"
                  | "ripemd128"
                  | "ripemd160"
                  | "tiger128"
                  | "tiger160"
                  | "tiger192"
                  | "crc32"
                  | "crc32b"
                  | "adler32"
              )[],
          ]

          The hash types.

        Returns HashAction<TInput$1, undefined>

        A hash action.

      • <
            TInput$1 extends string,
            const TMessage extends ErrorMessage<HashIssue<TInput$1>> | undefined,
        >(
            types: [
                | "md4"
                | "md5"
                | "sha1"
                | "sha256"
                | "sha384"
                | "sha512"
                | "ripemd128"
                | "ripemd160"
                | "tiger128"
                | "tiger160"
                | "tiger192"
                | "crc32"
                | "crc32b"
                | "adler32",
                ...(
                    | "md4"
                    | "md5"
                    | "sha1"
                    | "sha256"
                    | "sha384"
                    | "sha512"
                    | "ripemd128"
                    | "ripemd160"
                    | "tiger128"
                    | "tiger160"
                    | "tiger192"
                    | "crc32"
                    | "crc32b"
                    | "adler32"
                )[],
            ],
            message: TMessage,
        ): HashAction<TInput$1, TMessage>

      • Creates a hash validation action.

        Type Parameters

        Parameters

        • types: [
              | "md4"
              | "md5"
              | "sha1"
              | "sha256"
              | "sha384"
              | "sha512"
              | "ripemd128"
              | "ripemd160"
              | "tiger128"
              | "tiger160"
              | "tiger192"
              | "crc32"
              | "crc32b"
              | "adler32",
              ...(
                  | "md4"
                  | "md5"
                  | "sha1"
                  | "sha256"
                  | "sha384"
                  | "sha512"
                  | "ripemd128"
                  | "ripemd160"
                  | "tiger128"
                  | "tiger160"
                  | "tiger192"
                  | "crc32"
                  | "crc32b"
                  | "adler32"
              )[],
          ]

          The hash types.

        • message: TMessage

          The error message.

        Returns HashAction<TInput$1, TMessage>

        A hash action.

    requirement: RegExp

    The hash regex.

    type: "hash"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties