# Interface TransformOptions

interface TransformOptions {
signal?: AbortSignal;
emitClose?: boolean;
highWaterMark?: number;
objectMode?: boolean;
autoDestroy?: boolean;
encoding?: BufferEncoding;
decodeStrings?: boolean;
defaultEncoding?: BufferEncoding;
allowHalfOpen?: boolean;
readableObjectMode?: boolean;
writableObjectMode?: boolean;
readableHighWaterMark?: number;
writableHighWaterMark?: number;
writableCorked?: number;
construct?(this: Transform, callback: ((error?: Error) => void)): void;
read?(this: Transform, size: number): void;
write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: ((error?: Error) => void)): void;
writev?(this: Transform, chunks: {
chunk: any;
encoding: BufferEncoding;
}[], callback: ((error?: Error) => void)): void;
final?(this: Transform, callback: ((error?: Error) => void)): void;
destroy?(this: Transform, error: Error, callback: ((error?: Error) => void)): void;
transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
flush?(this: Transform, callback: TransformCallback): void;
}

#### Hierarchy (view full)

- DuplexOptions
  - TransformOptions

- Defined in node_modules/@types/node/stream.d.ts:1214

#####
Index

### Properties

signal?
emitClose?
highWaterMark?
objectMode?
autoDestroy?
encoding?
decodeStrings?
defaultEncoding?
allowHalfOpen?
readableObjectMode?
writableObjectMode?
readableHighWaterMark?
writableHighWaterMark?
writableCorked?

### Methods

construct?
read?
write?
writev?
final?
destroy?
transform?
flush?

##
Properties

### `Optional` signal

signal?: AbortSignal

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

Inherited from DuplexOptions.signal

- Defined in node_modules/@types/node/events.d.ts:437

### `Optional` emitClose

emitClose?: boolean

Inherited from DuplexOptions.emitClose

- Defined in node_modules/@types/node/stream.d.ts:45

### `Optional` highWaterMark

highWaterMark?: number

Inherited from DuplexOptions.highWaterMark

- Defined in node_modules/@types/node/stream.d.ts:46

### `Optional` objectMode

objectMode?: boolean

Inherited from DuplexOptions.objectMode

- Defined in node_modules/@types/node/stream.d.ts:47

### `Optional` autoDestroy

autoDestroy?: boolean

Inherited from DuplexOptions.autoDestroy

- Defined in node_modules/@types/node/stream.d.ts:50

### `Optional` encoding

encoding?: BufferEncoding

Inherited from DuplexOptions.encoding

- Defined in node_modules/@types/node/stream.d.ts:53

### `Optional` decodeStrings

decodeStrings?: boolean

Inherited from DuplexOptions.decodeStrings

- Defined in node_modules/@types/node/stream.d.ts:685

### `Optional` defaultEncoding

defaultEncoding?: BufferEncoding

Inherited from DuplexOptions.defaultEncoding

- Defined in node_modules/@types/node/stream.d.ts:686

### `Optional` allowHalfOpen

allowHalfOpen?: boolean

Inherited from DuplexOptions.allowHalfOpen

- Defined in node_modules/@types/node/stream.d.ts:1010

### `Optional` readableObjectMode

readableObjectMode?: boolean

Inherited from DuplexOptions.readableObjectMode

- Defined in node_modules/@types/node/stream.d.ts:1011

### `Optional` writableObjectMode

writableObjectMode?: boolean

Inherited from DuplexOptions.writableObjectMode

- Defined in node_modules/@types/node/stream.d.ts:1012

### `Optional` readableHighWaterMark

readableHighWaterMark?: number

Inherited from DuplexOptions.readableHighWaterMark

- Defined in node_modules/@types/node/stream.d.ts:1013

### `Optional` writableHighWaterMark

writableHighWaterMark?: number

Inherited from DuplexOptions.writableHighWaterMark

- Defined in node_modules/@types/node/stream.d.ts:1014

### `Optional` writableCorked

writableCorked?: number

Inherited from DuplexOptions.writableCorked

- Defined in node_modules/@types/node/stream.d.ts:1015

##
Methods

### `Optional` construct

- construct(this, callback): void

- #### Parameters

  - this: Transform
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Overrides DuplexOptions.construct

  - Defined in node_modules/@types/node/stream.d.ts:1215

### `Optional` read

- read(this, size): void

- #### Parameters

  - this: Transform
  - size: number

  #### Returns void

  Overrides DuplexOptions.read

  - Defined in node_modules/@types/node/stream.d.ts:1216

### `Optional` write

- write(this, chunk, encoding, callback): void

- #### Parameters

  - this: Transform
  - chunk: any
  - encoding: BufferEncoding
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Overrides DuplexOptions.write

  - Defined in node_modules/@types/node/stream.d.ts:1217

### `Optional` writev

- writev(this, chunks, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Overrides DuplexOptions.writev

  - Defined in node_modules/@types/node/stream.d.ts:1223

### `Optional` final

- final(this, callback): void

- #### Parameters

  - this: Transform
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Overrides DuplexOptions.final

  - Defined in node_modules/@types/node/stream.d.ts:1231

### `Optional` destroy

- destroy(this, error, callback): void

- #### Parameters

  - this: Transform
  - error: Error
  - callback: ((error?: Error) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Overrides DuplexOptions.destroy

  - Defined in node_modules/@types/node/stream.d.ts:1232

### `Optional` transform

- transform(this, chunk, encoding, callback): void

- #### Parameters

  - this: Transform
  - chunk: any
  - encoding: BufferEncoding
  - callback: TransformCallback

  #### Returns void

  - Defined in node_modules/@types/node/stream.d.ts:1233

### `Optional` flush

- flush(this, callback): void

- #### Parameters

  - this: Transform
  - callback: TransformCallback

  #### Returns void

  - Defined in node_modules/@types/node/stream.d.ts:1234