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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Interface: DuplexOptions

internal.DuplexOptions

Hierarchy

• ReadableOptions

• WritableOptions

  ↳ DuplexOptions

  ↳↳ TransformOptions

Properties

allowHalfOpen

• Optional allowHalfOpen: boolean

Defined in

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

---

autoDestroy

• Optional autoDestroy: boolean

Inherited from

WritableOptions.autoDestroy

Defined in

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

---

decodeStrings

• Optional decodeStrings: boolean

Inherited from

WritableOptions.decodeStrings

Defined in

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

---

defaultEncoding

• Optional defaultEncoding: BufferEncoding

Inherited from

WritableOptions.defaultEncoding

Defined in

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

---

emitClose

• Optional emitClose: boolean

Inherited from

WritableOptions.emitClose

Defined in

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

---

encoding

• Optional encoding: BufferEncoding

Inherited from

ReadableOptions.encoding

Defined in

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

---

highWaterMark

• Optional highWaterMark: number

Inherited from

WritableOptions.highWaterMark

Defined in

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

---

objectMode

• Optional objectMode: boolean

Inherited from

WritableOptions.objectMode

Defined in

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

---

readableHighWaterMark

• Optional readableHighWaterMark: number

Defined in

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

---

readableObjectMode

• Optional readableObjectMode: boolean

Defined in

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

---

signal

• Optional signal: AbortSignal

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

Inherited from

WritableOptions.signal

Defined in

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

---

writableCorked

• Optional writableCorked: number

Defined in

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

---

writableHighWaterMark

• Optional writableHighWaterMark: number

Defined in

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

---

writableObjectMode

• Optional writableObjectMode: boolean

Defined in

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

Methods

construct

▸ Optional construct(this, callback): void

Parameters

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

Returns

void

Overrides

WritableOptions.construct

Defined in

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

---

destroy

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

Parameters

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

Returns

void

Overrides

WritableOptions.destroy

Defined in

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

---

final

▸ Optional final(this, callback): void

Parameters

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

Returns

void

Overrides

WritableOptions.final

Defined in

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

---

read

▸ Optional read(this, size): void

Parameters

Name	Type
this	Duplex
size	number

Returns

void

Overrides

ReadableOptions.read

Defined in

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

---

write

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

Parameters

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

Returns

void

Overrides

WritableOptions.write

Defined in

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

---

writev

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

Parameters

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

Returns

void

Overrides

WritableOptions.writev

Defined in

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