Files
medusa-store/www/apps/docs/content/references/js-client/modules/internal-10.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

13 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Module: internal

Interfaces

Type Aliases

AdminCreateUploadPayload

Ƭ AdminCreateUploadPayload: File | File[]

Defined in

packages/medusa-js/src/typings.ts:51


BlobPart

Ƭ BlobPart: BufferSource | Blob | string

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:27961


BufferSource

Ƭ BufferSource: ArrayBufferView | ArrayBuffer

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:27963


EndingType

Ƭ EndingType: "native" | "transparent"

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:28077


ReadableStreamController

Ƭ ReadableStreamController<T>: ReadableStreamDefaultController<T> | ReadableByteStreamController

Type parameters

Name
T

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:28012


ReadableStreamReadResult

Ƭ ReadableStreamReadResult<T>: ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>

Type parameters

Name
T

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:28013


ReadableStreamReader

Ƭ ReadableStreamReader<T>: ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader

Type parameters

Name
T

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:28014

Variables

File

File: Object

Call signature

new File(fileBits, fileName, options?): File

Parameters
Name Type
fileBits BlobPart[]
fileName string
options? FilePropertyBag
Returns

File

Type declaration

Name Type
prototype File

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:8260

docs-util/node_modules/typescript/lib/lib.dom.d.ts:8269


ReadableByteStreamController

ReadableByteStreamController: Object

Call signature

new ReadableByteStreamController(): ReadableByteStreamController

Returns

ReadableByteStreamController

Type declaration

Name Type
prototype ReadableByteStreamController

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18464

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18477


ReadableStream

ReadableStream: Object

Call signature

new ReadableStream(underlyingSource, strategy?): ReadableStream<Uint8Array>

Parameters
Name Type
underlyingSource UnderlyingByteSource
strategy? Object
strategy.highWaterMark? number
Returns

ReadableStream<Uint8Array>

new ReadableStream<R>(underlyingSource, strategy?): ReadableStream<R>

Type parameters
Name Type
R any
Parameters
Name Type
underlyingSource UnderlyingDefaultSource<R>
strategy? QueuingStrategy<R>
Returns

ReadableStream<R>

new ReadableStream<R>(underlyingSource?, strategy?): ReadableStream<R>

Type parameters
Name Type
R any
Parameters
Name Type
underlyingSource? UnderlyingSource<R>
strategy? QueuingStrategy<R>
Returns

ReadableStream<R>

Type declaration

Name Type
prototype ReadableStream<any>

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18487

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18504


ReadableStreamBYOBReader

ReadableStreamBYOBReader: Object

Call signature

new ReadableStreamBYOBReader(stream): ReadableStreamBYOBReader

Parameters
Name Type
stream ReadableStream<any>
Returns

ReadableStreamBYOBReader

Type declaration

Name Type
prototype ReadableStreamBYOBReader

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18512

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18519


ReadableStreamBYOBRequest

ReadableStreamBYOBRequest: Object

Call signature

new ReadableStreamBYOBRequest(): ReadableStreamBYOBRequest

Returns

ReadableStreamBYOBRequest

Type declaration

Name Type
prototype ReadableStreamBYOBRequest

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18525

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18534


ReadableStreamDefaultController

ReadableStreamDefaultController: Object

Call signature

new ReadableStreamDefaultController(): ReadableStreamDefaultController<any>

Returns

ReadableStreamDefaultController<any>

Type declaration

Name Type
prototype ReadableStreamDefaultController<any>

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18540

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18551


ReadableStreamDefaultReader

ReadableStreamDefaultReader: Object

Call signature

new ReadableStreamDefaultReader<R>(stream): ReadableStreamDefaultReader<R>

Type parameters
Name Type
R any
Parameters
Name Type
stream ReadableStream<R>
Returns

ReadableStreamDefaultReader<R>

Type declaration

Name Type
prototype ReadableStreamDefaultReader<any>

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18557

docs-util/node_modules/typescript/lib/lib.dom.d.ts:18564


WritableStream

WritableStream: Object

Call signature

new WritableStream<W>(underlyingSink?, strategy?): WritableStream<W>

Type parameters
Name Type
W any
Parameters
Name Type
underlyingSink? UnderlyingSink<W>
strategy? QueuingStrategy<W>
Returns

WritableStream<W>

Type declaration

Name Type
prototype WritableStream<any>

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26020

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26031


WritableStreamDefaultController

WritableStreamDefaultController: Object

Call signature

new WritableStreamDefaultController(): WritableStreamDefaultController

Returns

WritableStreamDefaultController

Type declaration

Name Type
prototype WritableStreamDefaultController

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26041

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26048


WritableStreamDefaultWriter

WritableStreamDefaultWriter: Object

Call signature

new WritableStreamDefaultWriter<W>(stream): WritableStreamDefaultWriter<W>

Type parameters
Name Type
W any
Parameters
Name Type
stream WritableStream<W>
Returns

WritableStreamDefaultWriter<W>

Type declaration

Name Type
prototype WritableStreamDefaultWriter<any>

Defined in

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26058

docs-util/node_modules/typescript/lib/lib.dom.d.ts:26075