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

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: WritableStreamDefaultWriter<W>

internal.WritableStreamDefaultWriter

This Streams API interface is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.

Type parameters

Name Type
W any

Properties

closed

Readonly closed: Promise<undefined>

Defined in

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


desiredSize

Readonly desiredSize: null | number

Defined in

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


ready

Readonly ready: Promise<undefined>

Defined in

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

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:231


close

close(): Promise<void>

Returns

Promise<void>

Defined in

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


releaseLock

releaseLock(): void

Returns

void

Defined in

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


write

write(chunk?): Promise<void>

Parameters

Name Type
chunk? W

Returns

Promise<void>

Defined in

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