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

chore(docs): Generated JS Client Reference (#5421)

Browse Source 
* 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]
2023-10-20 14:01:27 +03:00
committed by GitHub
co-authored by olivermrbl Shahed nasser
parent 83f46b9b32
commit 9dcd62c731
1604 changed files with 211689 additions and 151746 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx
+51
View File
@@ -0,0 +1,51 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# finished
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).finished
## Functions
### \_\_promisify\_\_
▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../../internal/interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`FinishedOptions`](../interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx
+582
View File
@@ -0,0 +1,582 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# pipeline
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).pipeline
## Functions
### \_\_promisify\_\_
▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "source",
"type": "`A`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "destination",
"type": "`B`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.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`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.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`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T3",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.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`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "A",
"type": "[`PipelineSource`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinesource)<`any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T1",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T2",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T3",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "T4",
"type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T3`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "B",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.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`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
"name": "PipelinePromise",
"type": "[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "streams",
"type": "readonly ([`ReadableStream`](../../internal/interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`PipelineOptions`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "stream1",
"type": "[`ReadableStream`](../../internal/interfaces/admin_discounts.internal.ReadableStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "stream2",
"type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "streams",
"type": "([`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`ReadWriteStream`](../../internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx) \\| [`PipelineOptions`](../interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx))[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />