Interface TransformOptions

Hierarchy

"node:stream".DuplexOptions
- TransformOptions

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` 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, callback): void
Parameters
- this: "node:stream".Transform
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.construct
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1247

`Optional` destroy

destroy(this, error, callback): void
Parameters
- this: "node:stream".Transform
- error: null | Error
- callback: ((error) => void)
  - - (error): void
    - Parameters
      error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.destroy
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1264

`Optional` final

final(this, callback): void
Parameters
- this: "node:stream".Transform
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.final
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1263

`Optional` flush

flush(this, callback): void
Parameters
- this: "node:stream".Transform
- callback: "node:stream".TransformCallback
Returns void
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1266

`Optional` read

read(this, size): void
Parameters
- this: "node:stream".Transform
- size: number
Returns void
Overrides DuplexOptions.read
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1248

`Optional` transform

transform(this, chunk, encoding, callback): void
Parameters
- this: "node:stream".Transform
- chunk: any
- encoding: BufferEncoding
- callback: "node:stream".TransformCallback
Returns void
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1265

`Optional` write

write(this, chunk, encoding, callback): void
Parameters
- this: "node:stream".Transform
- chunk: any
- encoding: BufferEncoding
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.write
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1249

`Optional` writev

writev(this, chunks, callback): void
Parameters
- this: "node:stream".Transform
- chunks: {
  chunk: any;
  encoding: BufferEncoding;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.writev
- Defined in node_modules/.pnpm/@types+node@20.9.2/node_modules/@types/node/stream.d.ts:1255

Generated using TypeDoc