Interface ChecksumOptions

Options for computeChecksum

interface ChecksumOptions {
    algorithm?:
        | "sha1"
        | "sha256"
        | "sha512"
        | "md5";
    hash?: Hash;
    hashOptions?: HashOptions;
    stripContent?: boolean;
    stripOptions?: StripOptions;
}

Properties

algorithm? hash? hashOptions? stripContent? stripOptions?

Properties

Optionalalgorithm

algorithm?:
    | "sha1"
    | "sha256"
    | "sha512"
    | "md5"

Checksum algorithm to use.

Default

'sha1'

Optionalhash

hash?: Hash

Existing crypto#Hash instance to use.

Default

undefined

OptionalhashOptions

hashOptions?: HashOptions

crypto#HashOptions passed to hash. Only used if :hash is undefined.

Default

undefined

OptionalstripContent

stripContent?: boolean

Strip any formatting prior to computing hash.

Default

false

OptionalstripOptions

stripOptions?: StripOptions

Use stripFormatting prior to hashing content. Requires :stripFormatting to be true.

Default

undefined

Settings

Member Visibility

On This Page

Properties