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, callback): void;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    flush?(this, callback): void;
    read?(this, size): void;
    transform?(this, chunk, encoding, callback): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): void;
}

Hierarchy (view full)

Properties

allowHalfOpen?: boolean
autoDestroy?: boolean
decodeStrings?: boolean
defaultEncoding?: BufferEncoding
emitClose?: boolean
encoding?: BufferEncoding
highWaterMark?: number
objectMode?: boolean
outputLength?: number

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

readableHighWaterMark?: number
readableObjectMode?: boolean
signal?: AbortSignal

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

writableCorked?: number
writableHighWaterMark?: number
writableObjectMode?: boolean

Methods

  • Parameters

    • this: Transform
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • this: Transform
    • error: null | Error
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • this: Transform
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • this: Transform
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • this: Transform
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Generated using TypeDoc