chore(docs): Generated JS Client Reference (#5421)
* chore(docs): Generated JS Client Reference (automated) * fix js client reference * fix links --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
co-authored by
olivermrbl
Shahed nasser
olivermrbl
Shahed nasser
parent
83f46b9b32
commit
9dcd62c731
+251
@@ -0,0 +1,251 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AdminUploadsResource
|
||||
|
||||
[admin/uploads](../../modules/admin_uploads.mdx).AdminUploadsResource
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "headers",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "headers.Content-Type",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`\"multipart/form-data\"`",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### \_createPayload
|
||||
|
||||
▸ `Private` **_createPayload**(`file`): `FormData`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "file",
|
||||
"type": "[`AdminCreateUploadPayload`](../modules/admin_uploads.internal.mdx#admincreateuploadpayload)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`FormData`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "file",
|
||||
"type": "[`AdminCreateUploadPayload`](../modules/admin_uploads.internal.mdx#admincreateuploadpayload)",
|
||||
"description": "File or array of files to upload.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "Uploaded file or files.",
|
||||
"children": [
|
||||
{
|
||||
"name": "AdminUploadsRes",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Description
|
||||
|
||||
Uploads at least one file to the specific fileservice that is installed in Medusa.
|
||||
|
||||
___
|
||||
|
||||
### createProtected
|
||||
|
||||
▸ **createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "file",
|
||||
"type": "[`AdminCreateUploadPayload`](../modules/admin_uploads.internal.mdx#admincreateuploadpayload)",
|
||||
"description": "File or array of files to upload.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "Uploaded file or files.",
|
||||
"children": [
|
||||
{
|
||||
"name": "AdminUploadsRes",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Description
|
||||
|
||||
Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa.
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "payload",
|
||||
"type": "[`AdminDeleteUploadsReq`](../../internal/classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customHeaders",
|
||||
"type": "Record<`string`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`{}`",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "DeleteResponse",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getPresignedDownloadUrl
|
||||
|
||||
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "payload",
|
||||
"type": "[`AdminPostUploadsDownloadUrlReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customHeaders",
|
||||
"type": "Record<`string`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`{}`",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ResponsePromise",
|
||||
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "AdminUploadsDownloadUrlRes",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+769
@@ -0,0 +1,769 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# internal
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [BlobPropertyBag](../../internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx)
|
||||
- [File](../../internal/interfaces/admin_uploads.internal.File.mdx)
|
||||
- [FilePropertyBag](../../internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx)
|
||||
- [QueuingStrategy](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)
|
||||
- [QueuingStrategySize](../../internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx)
|
||||
- [ReadableByteStreamController](../../internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx)
|
||||
- [ReadableStream](../../internal/interfaces/admin_uploads.internal.ReadableStream.mdx)
|
||||
- [ReadableStreamBYOBReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx)
|
||||
- [ReadableStreamBYOBRequest](../../internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx)
|
||||
- [ReadableStreamDefaultController](../../internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx)
|
||||
- [ReadableStreamDefaultReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx)
|
||||
- [ReadableStreamGenericReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx)
|
||||
- [ReadableStreamGetReaderOptions](../../internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx)
|
||||
- [ReadableStreamReadDoneResult](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)
|
||||
- [ReadableStreamReadValueResult](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)
|
||||
- [ReadableWritablePair](../../internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx)
|
||||
- [StreamPipeOptions](../../internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx)
|
||||
- [UnderlyingByteSource](../../internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx)
|
||||
- [UnderlyingDefaultSource](../../internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx)
|
||||
- [UnderlyingSink](../../internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx)
|
||||
- [UnderlyingSinkAbortCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx)
|
||||
- [UnderlyingSinkCloseCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx)
|
||||
- [UnderlyingSinkStartCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx)
|
||||
- [UnderlyingSinkWriteCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx)
|
||||
- [UnderlyingSource](../../internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx)
|
||||
- [UnderlyingSourceCancelCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx)
|
||||
- [UnderlyingSourcePullCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx)
|
||||
- [UnderlyingSourceStartCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx)
|
||||
- [WritableStream](../../internal/interfaces/admin_uploads.internal.WritableStream.mdx)
|
||||
- [WritableStreamDefaultController](../../internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx)
|
||||
- [WritableStreamDefaultWriter](../../internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCreateUploadPayload
|
||||
|
||||
Ƭ **AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[]
|
||||
|
||||
___
|
||||
|
||||
### BlobPart
|
||||
|
||||
Ƭ **BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string`
|
||||
|
||||
___
|
||||
|
||||
### BufferSource
|
||||
|
||||
Ƭ **BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer`
|
||||
|
||||
___
|
||||
|
||||
### EndingType
|
||||
|
||||
Ƭ **EndingType**: ``"native"`` \| ``"transparent"``
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamController
|
||||
|
||||
Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamReadResult
|
||||
|
||||
Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamReader
|
||||
|
||||
Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
|
||||
|
||||
#### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Variables
|
||||
|
||||
### File
|
||||
|
||||
• **File**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file)
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fileBits",
|
||||
"type": "[`BlobPart`](admin_uploads.internal.mdx#blobpart)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "fileName",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FilePropertyBag`](../../internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`File`](admin_uploads.internal.mdx#file)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "File",
|
||||
"type": "[`File`](admin_uploads.internal.mdx#file)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`File`](admin_uploads.internal.mdx#file)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableByteStreamController
|
||||
|
||||
• **ReadableByteStreamController**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableByteStreamController",
|
||||
"type": "() => [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStream
|
||||
|
||||
• **ReadableStream**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "underlyingSource",
|
||||
"type": "[`UnderlyingByteSource`](../../internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "strategy",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "strategy.highWaterMark",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStream",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "Uint8Array",
|
||||
"type": "`Uint8Array`",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "R",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "underlyingSource",
|
||||
"type": "[`UnderlyingDefaultSource`](../../internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx)<`R`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "strategy",
|
||||
"type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`R`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStream",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "R",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "underlyingSource",
|
||||
"type": "[`UnderlyingSource`](../../internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx)<`R`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "strategy",
|
||||
"type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`R`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStream",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamBYOBReader
|
||||
|
||||
• **ReadableStreamBYOBReader**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "stream",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStreamBYOBReader",
|
||||
"type": "(`stream`: [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`any`\\>) => [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamBYOBRequest
|
||||
|
||||
• **ReadableStreamBYOBRequest**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStreamBYOBRequest",
|
||||
"type": "() => [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultController
|
||||
|
||||
• **ReadableStreamDefaultController**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\>
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStreamDefaultController",
|
||||
"type": "[`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### ReadableStreamDefaultReader
|
||||
|
||||
• **ReadableStreamDefaultReader**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "R",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "stream",
|
||||
"type": "[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ReadableStreamDefaultReader",
|
||||
"type": "[`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### WritableStream
|
||||
|
||||
• **WritableStream**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "W",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "underlyingSink",
|
||||
"type": "[`UnderlyingSink`](../../internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx)<`W`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "strategy",
|
||||
"type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`W`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "WritableStream",
|
||||
"type": "[`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`WritableStream`](admin_uploads.internal.mdx#writablestream)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultController
|
||||
|
||||
• **WritableStreamDefaultController**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)
|
||||
|
||||
##### Returns
|
||||
|
||||
[`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "WritableStreamDefaultController",
|
||||
"type": "() => [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### WritableStreamDefaultWriter
|
||||
|
||||
• **WritableStreamDefaultWriter**: `Object`
|
||||
|
||||
#### Call signature
|
||||
|
||||
• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "W",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "stream",
|
||||
"type": "[`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
|
||||
[`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "WritableStreamDefaultWriter",
|
||||
"type": "[`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prototype",
|
||||
"type": "[`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Reference in New Issue
Block a user