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/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx
+46
View File
@@ -0,0 +1,46 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FinishedOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).FinishedOptions
## Properties
<ParameterTypes parameters={[
{
"name": "error",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "readable",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "writable",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx
+93
View File
@@ -0,0 +1,93 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# Pipe
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).Pipe
## Methods
### close
▸ **close**(): `void`
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### hasRef
▸ **hasRef**(): `boolean`
#### Returns
`boolean`
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### ref
▸ **ref**(): `void`
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### unref
▸ **unref**(): `void`
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PipelineOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).PipelineOptions
## Properties
<ParameterTypes parameters={[
{
"name": "end",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx
+204
View File
@@ -0,0 +1,204 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ReadableOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).ReadableOptions
## Properties
<ParameterTypes parameters={[
{
"name": "autoDestroy",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "emitClose",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "highWaterMark",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "objectMode",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
## Methods
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../../internal/classes/admin_discounts.internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
#### Inherited from
[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[construct](admin_discounts.internal.internal-2.StreamOptions.mdx#construct)
___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../../internal/classes/admin_discounts.internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
#### Inherited from
[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[destroy](admin_discounts.internal.internal-2.StreamOptions.mdx#destroy)
___
### read
▸ `Optional` **read**(`this`, `size`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Readable`](../../internal/classes/admin_discounts.internal.Readable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "size",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx
+159
View File
@@ -0,0 +1,159 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# StreamOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).StreamOptions
## Type parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "[`Stream`](../../internal/classes/admin_discounts.internal.Stream.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "autoDestroy",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "emitClose",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "highWaterMark",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "objectMode",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
## Methods
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "`T`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "`T`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx
+320
View File
@@ -0,0 +1,320 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# WritableOptions
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).WritableOptions
## Properties
<ParameterTypes parameters={[
{
"name": "autoDestroy",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "decodeStrings",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "defaultEncoding",
"type": "[`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "emitClose",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "highWaterMark",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "objectMode",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
## Methods
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
#### Inherited from
[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[construct](admin_discounts.internal.internal-2.StreamOptions.mdx#construct)
___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "error",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
#### Inherited from
[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[destroy](admin_discounts.internal.internal-2.StreamOptions.mdx#destroy)
___
### final
▸ `Optional` **final**(`this`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### write
▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "chunk",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "encoding",
"type": "[`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### writev
▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void`
#### Parameters
<ParameterTypes parameters={[
{
"name": "this",
"type": "[`Writable`](../classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "chunks",
"type": "{ `chunk`: `any` ; `encoding`: [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding) }[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`error?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />