Interface AsyncTransformOptions<T>

Type Parameters

T = unknown

Hierarchy

DuplexOptions
- AsyncTransformOptions

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` flush

flush?: ((this) => unknown)

Type declaration

- (this): unknown
- Performs any final actions after the source has ended
  Parameters
  - this: Transform
  Returns unknown

`Optional` highWaterMark

highWaterMark?: number

`Optional` objectMode

objectMode?: boolean

`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` transform

transform?: ((this, data, encoding) => unknown)

Type declaration

- (this, data, encoding): unknown
- Transforms data from the source by calling the push method
  Parameters
  - this: Transform
  - data: T
  - encoding: string
  Returns unknown

`Optional` writableCorked

writableCorked?: number

`Optional` writableHighWaterMark

writableHighWaterMark?: number

`Optional` writableObjectMode

writableObjectMode?: boolean

Methods

`Optional` construct

construct(this, callback): void
Parameters
- this: Duplex
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Inherited from DuplexOptions.construct
- Defined in node_modules/@types/node/stream.d.ts:1016

`Optional` destroy

destroy(this, error, callback): void
Parameters
- this: Duplex
- error: null | Error
- callback: ((error) => void)
  - - (error): void
    - Parameters
      
      error: null | Error
      
      Returns void
Returns void
Inherited from DuplexOptions.destroy
- Defined in node_modules/@types/node/stream.d.ts:1028

`Optional` final

final(this, callback): void
Parameters
- this: Duplex
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Inherited from DuplexOptions.final
- Defined in node_modules/@types/node/stream.d.ts:1027

`Optional` read

read(this, size): void
Parameters
- this: Duplex
- size: number
Returns void
Inherited from DuplexOptions.read
- Defined in node_modules/@types/node/stream.d.ts:1017

`Optional` write

write(this, chunk, encoding, callback): void
Parameters
- this: Duplex
- chunk: any
- encoding: BufferEncoding
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Inherited from DuplexOptions.write
- Defined in node_modules/@types/node/stream.d.ts:1018

`Optional` writev

writev(this, chunks, callback): void
Parameters
- this: Duplex
- chunks: {
  chunk: any;
  encoding: BufferEncoding;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      
      Optional error: null | Error
      
      Returns void
Returns void
Inherited from DuplexOptions.writev
- Defined in node_modules/@types/node/stream.d.ts:1019

Interface AsyncTransformOptions<T>

Type Parameters

T = unknown

Hierarchy

Index

Properties

Methods

Properties

Optional allowHalfOpen

Optional autoDestroy

Optional decodeStrings

Optional defaultEncoding

Optional emitClose

Optional encoding

Optional flush

Type declaration

Parameters

this: Transform

Returns unknown

Optional highWaterMark

Optional objectMode

Optional readableHighWaterMark

Optional readableObjectMode

Optional signal

Optional transform

Type declaration

Parameters

this: Transform

data: T

encoding: string

Returns unknown

Optional writableCorked

Optional writableHighWaterMark

Optional writableObjectMode

Methods

Optional construct

Parameters

this: Duplex

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional destroy

Parameters

this: Duplex

error: null | Error

callback: ((error) => void)

Parameters

error: null | Error

Returns void

Returns void

Optional final

Parameters

this: Duplex

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional read

Parameters

this: Duplex

size: number

Returns void

Optional write

Parameters

this: Duplex

chunk: any

encoding: BufferEncoding

callback: ((error?) => void)

Parameters

Optional error: null | Error

Returns void

Returns void

Optional writev

Parameters

this: Duplex

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

callback: ((error?) => void)

`Optional` allowHalfOpen

`Optional` autoDestroy

`Optional` decodeStrings

`Optional` defaultEncoding

`Optional` emitClose

`Optional` encoding

`Optional` flush

`Optional` highWaterMark

`Optional` objectMode

`Optional` readableHighWaterMark

`Optional` readableObjectMode

`Optional` signal

`Optional` transform

`Optional` writableCorked

`Optional` writableHighWaterMark

`Optional` writableObjectMode

`Optional` construct

`Optional` error: null | Error

`Optional` destroy

`Optional` final

`Optional` error: null | Error

`Optional` read

`Optional` write

`Optional` error: null | Error

`Optional` writev

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

`Optional` error: null | Error