Files
medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.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

1.3 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: WritableStream<W>

internal.WritableStream

This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in back pressure and queuing.

Type parameters

Name Type
W any

Properties

locked

Readonly locked: boolean

Defined in

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

Methods

abort

abort(reason?): Promise<void>

Parameters

Name Type
reason? any

Returns

Promise<void>

Defined in

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


close

close(): Promise<void>

Returns

Promise<void>

Defined in

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


getWriter

getWriter(): WritableStreamDefaultWriter<W>

Returns

WritableStreamDefaultWriter<W>

Defined in

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