TransformOptions | Tapjaw Importer API documentation

Hierarchy-Diagram

Legend

interface

public property

public method

Hierarchy

<internal>.internal.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: Transform, callback: (error?: null | <internal>.Error) => void): void

Overrides DuplexOptions.construct
- Defined in node_modules/@types/node/stream.d.ts:864
Parameters
- this: Transform
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional destroy

destroy(this: Transform, error: null | <internal>.Error, callback: (error: null | <internal>.Error) => void): void

Overrides DuplexOptions.destroy
- Defined in node_modules/@types/node/stream.d.ts:876
Parameters
- this: Transform
- error: null | <internal>.Error
- callback: (error: null | <internal>.Error) => void
  - - (error: null | <internal>.Error): void
    - Parameters
      - error: null | <internal>.Error
      Returns void
Returns void

Optional final

final(this: Transform, callback: (error?: null | <internal>.Error) => void): void

Overrides DuplexOptions.final
- Defined in node_modules/@types/node/stream.d.ts:875
Parameters
- this: Transform
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional flush

flush(this: Transform, callback: TransformCallback): void

- Defined in node_modules/@types/node/stream.d.ts:878
Parameters
- this: Transform
- callback: TransformCallback
Returns void

Optional read

read(this: Transform, size: number): void

Overrides DuplexOptions.read
- Defined in node_modules/@types/node/stream.d.ts:865
Parameters
- this: Transform
- size: number
Returns void

Optional transform

transform(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void

- Defined in node_modules/@types/node/stream.d.ts:877
Parameters
- this: Transform
- chunk: any
- encoding: BufferEncoding
- callback: TransformCallback
Returns void

Optional write

write(this: Transform, chunk: any, encoding: BufferEncoding, callback: (error?: null | <internal>.Error) => void): void

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

Optional writev

writev(this: Transform, chunks: { chunk: any; encoding: BufferEncoding }[], callback: (error?: null | <internal>.Error) => void): void

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

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Properties

Optional allowHalfOpen

Optional autoDestroy

Optional decodeStrings

Optional defaultEncoding

Optional emitClose

Optional encoding

Optional highWaterMark

Optional objectMode

Optional readableHighWaterMark

Optional readableObjectMode

Optional signal

Optional writableCorked

Optional writableHighWaterMark

Optional writableObjectMode

Methods

Optional construct

Parameters

this: Transform

callback: (error?: null | <internal>.Error) => void

Parameters

Optional error: null | <internal>.Error

Returns void

Returns void

Optional destroy

Parameters

this: Transform

error: null | <internal>.Error

callback: (error: null | <internal>.Error) => void

Parameters

error: null | <internal>.Error

Returns void

Returns void

Optional final

Parameters

this: Transform

callback: (error?: null | <internal>.Error) => void

Parameters

Optional error: null | <internal>.Error

Returns void

Returns void

Optional flush

Parameters

this: Transform

callback: TransformCallback

Returns void

Optional read

Parameters

this: Transform

size: number

Returns void

Optional transform

Parameters

this: Transform

chunk: any

encoding: BufferEncoding

callback: TransformCallback

Returns void

Optional write

Parameters

this: Transform

chunk: any

encoding: BufferEncoding

callback: (error?: null | <internal>.Error) => void

Parameters

Optional error: null | <internal>.Error

Returns void

Returns void

Optional writev

Parameters

this: Transform

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

callback: (error?: null | <internal>.Error) => void

Parameters