Files
medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

3.4 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: ReadableOptions

internal.internal.ReadableOptions

Hierarchy

Properties

autoDestroy

Optional autoDestroy: boolean

Inherited from

StreamOptions.autoDestroy

Defined in

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


emitClose

Optional emitClose: boolean

Inherited from

StreamOptions.emitClose

Defined in

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


encoding

Optional encoding: BufferEncoding

Defined in

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


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 Readable
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 Readable
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


read

Optional read(this, size): void

Parameters

Name Type
this Readable
size number

Returns

void

Defined in

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