Interface HashOptions

interface HashOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    highWaterMark?: number;
    objectMode?: boolean;
    outputLength?: number;
    readableHighWaterMark?: number;
    readableObjectMode?: boolean;
    signal?: AbortSignal;
    writableCorked?: number;
    writableHighWaterMark?: number;
    writableObjectMode?: boolean;
    construct(this: Transform, callback: (error?: null | Error) => void): void;
    destroy(
        this: Transform,
        error: null | Error,
        callback: (error?: null | Error) => void,
    ): void;
    final(this: Transform, callback: (error?: null | Error) => void): void;
    flush(this: Transform, callback: TransformCallback): void;
    read(this: Transform, size: number): void;
    transform(
        this: Transform,
        chunk: any,
        encoding: BufferEncoding,
        callback: TransformCallback,
    ): void;
    write(
        this: Transform,
        chunk: any,
        encoding: BufferEncoding,
        callback: (error?: null | Error) => void,
    ): void;
    writev(
        this: Transform,
        chunks: { chunk: any; encoding: BufferEncoding }[],
        callback: (error?: null | Error) => void,
    ): void;
}

Hierarchy (View Summary)

Properties

allowHalfOpen? autoDestroy? decodeStrings? defaultEncoding? emitClose? encoding? highWaterMark? objectMode? outputLength? readableHighWaterMark? readableObjectMode? signal? writableCorked? writableHighWaterMark? writableObjectMode?

Methods

construct? destroy? final? flush? read? transform? write? writev?

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalautoDestroy

autoDestroy?: boolean

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalemitClose

emitClose?: boolean

Optionalencoding

encoding?: BufferEncoding

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

OptionaloutputLength

outputLength?: number

For XOF hash functions such as shake256, the outputLength option can be used to specify the desired output length in bytes.

OptionalreadableHighWaterMark

readableHighWaterMark?: number

OptionalreadableObjectMode

readableObjectMode?: boolean

Optionalsignal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

OptionalwritableCorked

writableCorked?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

OptionalwritableObjectMode

writableObjectMode?: boolean

Methods

Optionalconstruct

Optionaldestroy

Optionalfinal

Optionalflush

Optionalread

Optionaltransform

Optionalwrite

Optionalwritev

Settings

Member Visibility

On This Page

Properties
Methods