# Interface WritableOptions

interface WritableOptions {
signal?: AbortSignal;
emitClose?: boolean;
highWaterMark?: number;
objectMode?: boolean;
construct?(this: Writable, callback: ((error?: Error) => void)): void;
destroy?(this: Writable, error: Error, callback: ((error?: Error) => void)): void;
autoDestroy?: boolean;
decodeStrings?: boolean;
defaultEncoding?: BufferEncoding;
write?(this: Writable, chunk: any, encoding: BufferEncoding, callback: ((error?: Error) => void)): void;
writev?(this: Writable, chunks: {
chunk: any;
encoding: BufferEncoding;
}[], callback: ((error?: Error) => void)): void;
final?(this: Writable, callback: ((error?: Error) => void)): void;
}

#### Hierarchy (view full)

- StreamOptions<Writable>
  - WritableOptions
    - DuplexOptions

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

#####
Index

### Properties

signal?
emitClose?
highWaterMark?
objectMode?
autoDestroy?
decodeStrings?
defaultEncoding?

### Methods

construct?
destroy?
write?
writev?
final?

##
Properties

### `Optional` signal

signal?: AbortSignal

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

Inherited from StreamOptions.signal

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

### `Optional` emitClose

emitClose?: boolean

Inherited from StreamOptions.emitClose

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

### `Optional` highWaterMark

highWaterMark?: number

Inherited from StreamOptions.highWaterMark

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

### `Optional` objectMode

objectMode?: boolean

Inherited from StreamOptions.objectMode

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

### `Optional` autoDestroy

autoDestroy?: boolean

Inherited from StreamOptions.autoDestroy

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

### `Optional` decodeStrings

decodeStrings?: boolean

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

### `Optional` defaultEncoding

defaultEncoding?: BufferEncoding

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

##
Methods

### `Optional` construct

- construct(this, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Inherited from StreamOptions.construct

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

### `Optional` destroy

- destroy(this, error, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

  Inherited from StreamOptions.destroy

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

### `Optional` write

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

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

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

### `Optional` writev

- writev(this, chunks, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

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

### `Optional` final

- final(this, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: Error

        #### Returns void

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