medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Interface: WritableOptions

internal.internal.WritableOptions

Hierarchy

• StreamOptions<Writable>

  ↳ WritableOptions

  ↳↳ DuplexOptions

Properties

autoDestroy

• Optional autoDestroy: boolean

Inherited from

StreamOptions.autoDestroy

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:776

---

decodeStrings

• Optional decodeStrings: boolean

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:800

---

defaultEncoding

• Optional defaultEncoding: BufferEncoding

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:801

---

emitClose

• Optional emitClose: boolean

Inherited from

StreamOptions.emitClose

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:771

---

highWaterMark

• Optional highWaterMark: number

Inherited from

StreamOptions.highWaterMark

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:772

---

objectMode

• Optional objectMode: boolean

Inherited from

StreamOptions.objectMode

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:773

---

signal

• Optional signal: AbortSignal

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

Inherited from

StreamOptions.signal

Defined in

packages/medusa-js/node_modules/@types/node/events.d.ts:380

Methods

construct

▸ Optional construct(this, callback): void

Parameters

Name	Type
this	Writable
callback	(error?: null | Error) => void

Returns

void

Inherited from

StreamOptions.construct

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:774

---

destroy

▸ Optional destroy(this, error, callback): void

Parameters

Name	Type
this	Writable
error	null | Error
callback	(error: null | Error) => void

Returns

void

Inherited from

StreamOptions.destroy

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:775

---

final

▸ Optional final(this, callback): void

Parameters

Name	Type
this	Writable
callback	(error?: null | Error) => void

Returns

void

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:811

---

write

▸ Optional write(this, chunk, encoding, callback): void

Parameters

Name	Type
this	Writable
chunk	any
encoding	BufferEncoding
callback	(error?: null | Error) => void

Returns

void

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:802

---

writev

▸ Optional writev(this, chunks, callback): void

Parameters

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

Returns

void

Defined in

packages/medusa-js/node_modules/@types/node/stream.d.ts:803