asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-1.mdx
+1156 -211
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx
+536 -1634
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx
+1194 -75
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx
+558 -189
View File
@@ -10,31 +10,39 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Functions
### arrayBuffer
### finished
**arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\>
**finished**(`stream`, `options?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`FinishedOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.FinishedOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`ArrayBuffer`\>
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`ArrayBuffer`\\>",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
@@ -44,16 +52,555 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
___
### blob
### pipeline
**blob**(`stream`): `Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\>
**pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](admin_discounts.internal.internal-3.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](admin_discounts.internal.internal-3.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform1",
"type": "`T1`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](admin_discounts.internal.internal-3.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform1",
"type": "`T1`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform2",
"type": "`T2`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](admin_discounts.internal.internal-3.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T3",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T2`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform1",
"type": "`T1`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform2",
"type": "`T2`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform3",
"type": "`T3`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](admin_discounts.internal.internal-3.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T3",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T2`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T4",
"type": "[`PipelineTransform`](admin_discounts.internal.internal-3.mdx#pipelinetransform)<`T3`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-3.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform1",
"type": "`T1`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform2",
"type": "`T2`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform3",
"type": "`T3`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "transform4",
"type": "`T4`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](admin_discounts.internal.internal-3.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**(`streams`, `options?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "streams",
"type": "readonly ([`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
**pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream1",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "stream2",
"type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "streams",
"type": "([`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx) \\| [`PipelineOptions`](../../internal-3/interfaces/admin_discounts.internal.internal-3.PipelineOptions.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -63,193 +610,15 @@ ___
#### Returns
`Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\>
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\\>",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "size",
"type": "`number`",
"description": "The total size of the `Blob` in bytes. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "The content-type of the `Blob`. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "arrayBuffer",
"type": "() => `Promise`<`ArrayBuffer`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "slice",
"type": "(`start?`: `number`, `end?`: `number`, `type?`: `string`) => [`Blob`](../classes/admin_discounts.internal.Blob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "stream",
"type": "() => [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "text",
"type": "() => `Promise`<`string`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
___
### buffer
**buffer**(`stream`): `Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "Buffer",
"type": "[`BufferConstructor`](../interfaces/admin_discounts.internal.BufferConstructor.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
___
### json
**json**(`stream`): `Promise`<`unknown`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`unknown`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
___
### text
**text**(`stream`): `Promise`<`string`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`string`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-5.mdx
+255
View File
@@ -0,0 +1,255 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# internal
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal
## Functions
### arrayBuffer
**arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`ArrayBuffer`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`ArrayBuffer`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### blob
**blob**(`stream`): `Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "size",
"type": "`number`",
"description": "The total size of the `Blob` in bytes. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "The content-type of the `Blob`. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "arrayBuffer",
"type": "() => `Promise`<`ArrayBuffer`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "slice",
"type": "(`start?`: `number`, `end?`: `number`, `type?`: `string`) => [`Blob`](../classes/admin_discounts.internal.Blob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "stream",
"type": "() => [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "text",
"type": "() => `Promise`<`string`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
___
### buffer
**buffer**(`stream`): `Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "Buffer",
"type": "[`BufferConstructor`](../interfaces/admin_discounts.internal.BufferConstructor.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
___
### json
**json**(`stream`): `Promise`<`unknown`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`unknown`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "unknown",
"type": "`unknown`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
___
### text
**text**(`stream`): `Promise`<`string`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`AsyncIterator`](../interfaces/admin_discounts.internal.AsyncIterator.mdx)<`any`, `any`, `undefined`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`string`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`string`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]
}
]} />
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx
+9 -2
View File
@@ -59,6 +59,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [AdminGetPriceListsPriceListProductsParams](../classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx)
- [AdminGetProductCategoriesParams](../classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx)
- [AdminGetProductCategoryParams](../classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx)
- [AdminGetProductParams](../classes/admin_discounts.internal.internal.AdminGetProductParams.mdx)
- [AdminGetProductTagsPaginationParams](../classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx)
- [AdminGetProductTagsParams](../classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx)
- [AdminGetProductTypesParams](../classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx)
@@ -5756,8 +5757,8 @@ ___
StoreBearerAuthRes
type: object
properties:
accessToken:
description: Access token for subsequent authorization.
access_token:
description: Access token that can be used to send authenticated requests.
type: string
#### Type declaration
@@ -7630,6 +7631,12 @@ ___
`Const` **filterableAdminOrdersFields**: `string`[]
___
### joinerConfig
`Const` **joinerConfig**: [`internal`](admin_discounts.internal.internal-1.mdx)[]
## Functions
### DbAwareColumn