Interface HashOptions

Hierarchy

"stream".TransformOptions
- HashOptions

Properties

`Optional` allowHalfOpen

allowHalfOpen?: boolean

`Optional` autoDestroy

autoDestroy?: boolean

`Optional` decodeStrings

decodeStrings?: boolean

`Optional` defaultEncoding

defaultEncoding?: BufferEncoding

`Optional` emitClose

emitClose?: boolean

`Optional` encoding

encoding?: BufferEncoding

`Optional` highWaterMark

highWaterMark?: number

`Optional` objectMode

objectMode?: boolean

`Optional` outputLength

outputLength?: number

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

`Optional` readableHighWaterMark

readableHighWaterMark?: number

`Optional` readableObjectMode

readableObjectMode?: boolean

`Optional` signal

signal?: AbortSignal

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

`Optional` writableCorked

writableCorked?: number

`Optional` writableHighWaterMark

writableHighWaterMark?: number

`Optional` writableObjectMode

writableObjectMode?: boolean

Methods

`Optional` construct

construct(this: "stream".Transform, callback: ((error?: Error) => void)): void
Parameters
- this: "stream".Transform
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

Inherited from TransformOptions.construct

`Optional` destroy

destroy(this: "stream".Transform, error: Error, callback: ((error: Error) => void)): void
Parameters
- this: "stream".Transform
- error: Error
- callback: ((error: Error) => void)
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns void

Inherited from TransformOptions.destroy

`Optional` final

final(this: "stream".Transform, callback: ((error?: Error) => void)): void
Parameters
- this: "stream".Transform
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

Inherited from TransformOptions.final

`Optional` flush

flush(this: "stream".Transform, callback: "stream".TransformCallback): void
Parameters
- this: "stream".Transform
- callback: "stream".TransformCallback
Returns void

Inherited from TransformOptions.flush

`Optional` read

read(this: "stream".Transform, size: number): void
Parameters
- this: "stream".Transform
- size: number
Returns void

Inherited from TransformOptions.read

`Optional` transform

transform(this: "stream".Transform, chunk: any, encoding: BufferEncoding, callback: "stream".TransformCallback): void
Parameters
- this: "stream".Transform
- chunk: any
- encoding: BufferEncoding
- callback: "stream".TransformCallback
Returns void

Inherited from TransformOptions.transform

`Optional` write

write(this: "stream".Transform, chunk: any, encoding: BufferEncoding, callback: ((error?: Error) => void)): void
Parameters
- this: "stream".Transform
- chunk: any
- encoding: BufferEncoding
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

Inherited from TransformOptions.write

`Optional` writev

writev(this: "stream".Transform, chunks: { chunk: any; encoding: BufferEncoding }[], callback: ((error?: Error) => void)): void
Parameters
- this: "stream".Transform
- chunks: { chunk: any; encoding: BufferEncoding }[]
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void

Inherited from TransformOptions.writev

Interface HashOptions

Hierarchy

Index

Properties

Methods

Properties

Optional allowHalfOpen

Optional autoDestroy

Optional decodeStrings

Optional defaultEncoding

Optional emitClose

Optional encoding

Optional highWaterMark

Optional objectMode

Optional outputLength

Optional readableHighWaterMark

Optional readableObjectMode

Optional signal

Optional writableCorked

Optional writableHighWaterMark

Optional writableObjectMode

Methods

Optional construct

Parameters

this: "stream".Transform

callback: ((error?: Error) => void)

Parameters

Optional error: Error

Returns void

Returns void

Optional destroy

Parameters

this: "stream".Transform

error: Error

callback: ((error: Error) => void)

Parameters

error: Error

Returns void

Returns void

Optional final

Parameters

this: "stream".Transform

callback: ((error?: Error) => void)

Parameters

Optional error: Error

Returns void

Returns void

Optional flush

Parameters

this: "stream".Transform

callback: "stream".TransformCallback

Returns void

Optional read

Parameters

this: "stream".Transform

size: number

Returns void

Optional transform

Parameters

this: "stream".Transform

chunk: any

encoding: BufferEncoding

callback: "stream".TransformCallback

Returns void

Optional write

Parameters

this: "stream".Transform

chunk: any

encoding: BufferEncoding

callback: ((error?: Error) => void)

Parameters

Optional error: Error

Returns void

Returns void

Optional writev

Parameters

this: "stream".Transform

chunks: { chunk: any; encoding: BufferEncoding }[]

callback: ((error?: Error) => void)

Parameters

`Optional` allowHalfOpen

`Optional` autoDestroy

`Optional` decodeStrings

`Optional` defaultEncoding

`Optional` emitClose

`Optional` encoding

`Optional` highWaterMark

`Optional` objectMode

`Optional` outputLength

`Optional` readableHighWaterMark

`Optional` readableObjectMode

`Optional` signal

`Optional` writableCorked

`Optional` writableHighWaterMark

`Optional` writableObjectMode

`Optional` construct

`Optional` error: Error

`Optional` destroy

`Optional` final

`Optional` error: Error

`Optional` flush

`Optional` read

`Optional` transform

`Optional` write

`Optional` error: Error

`Optional` writev

`Optional` error: Error