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

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

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-20 11:47:19 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 8203dec3e2
commit 39de54e2e8
96 changed files with 12353 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx
+3 -3
View File
@@ -52,7 +52,7 @@ Adds an address to a customers saved addresses
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ Deletes an address of a customer
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -166,7 +166,7 @@ Update an address of a customer
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx
+3 -3
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminAuthRes type: object required: - user properties: user: description: User details. $ref: \"#/components/schemas/User\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -135,7 +135,7 @@ ___
{
"name": "AdminAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminAuthRes type: object required: - user properties: user: description: User details. $ref: \"#/components/schemas/User\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -191,7 +191,7 @@ ___
{
"name": "AdminBearerAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminBearerAuthRes type: object properties: accessToken: description: Access token for subsequent authorization. type: string",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx
+5 -5
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminBatchJobRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminBatchJobRes type: object required: - batch_job properties: batch_job: description: Batch job details. $ref: \"#/components/schemas/BatchJob\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -101,7 +101,7 @@ ___
{
"name": "AdminBatchJobRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminBatchJobRes type: object required: - batch_job properties: batch_job: description: Batch job details. $ref: \"#/components/schemas/BatchJob\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -152,7 +152,7 @@ ___
{
"name": "AdminBatchJobRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminBatchJobRes type: object required: - batch_job properties: batch_job: description: Batch job details. $ref: \"#/components/schemas/BatchJob\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -203,7 +203,7 @@ ___
{
"name": "AdminBatchJobListRes",
"type": "[`PaginatedResponse`](../modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] }",
"description": "",
"description": "#### Schema AdminBatchJobListRes type: object required: - batch_jobs - count - offset - limit properties: batch_jobs: type: array description: An array of batch job details. items: $ref: \"#/components/schemas/BatchJob\" count: type: integer description: The total number of items available offset: type: integer description: The number of batch jobs skipped when retrieving the batch jobs. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -254,7 +254,7 @@ ___
{
"name": "AdminBatchJobRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminBatchJobRes type: object required: - batch_job properties: batch_job: description: Batch job details. $ref: \"#/components/schemas/BatchJob\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx
+6 -6
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCollectionsRes type: object x-expanded-relations: field: collection relations: - products required: - collection properties: collection: type: \"Product Collection details.\" $ref: \"#/components/schemas/ProductCollection\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ ___
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCollectionsRes type: object x-expanded-relations: field: collection relations: - products required: - collection properties: collection: type: \"Product Collection details.\" $ref: \"#/components/schemas/ProductCollection\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -223,7 +223,7 @@ ___
{
"name": "AdminCollectionsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }",
"description": "",
"description": "#### Schema AdminCollectionsListRes type: object required: - collections - count - offset - limit properties: collections: type: array description: an array of collection details items: $ref: \"#/components/schemas/ProductCollection\" count: type: integer description: The total number of items available offset: type: integer description: The number of product collections skipped when retrieving the product collections. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -286,7 +286,7 @@ ___
{
"name": "AdminDeleteProductsFromCollectionRes",
"type": "`object`",
"description": "",
"description": "#### Schema The ID of the collection",
"optional": false,
"defaultValue": "",
"children": []
@@ -341,7 +341,7 @@ ___
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCollectionsRes type: object x-expanded-relations: field: collection relations: - products required: - collection properties: collection: type: \"Product Collection details.\" $ref: \"#/components/schemas/ProductCollection\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -404,7 +404,7 @@ ___
{
"name": "AdminCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCollectionsRes type: object x-expanded-relations: field: collection relations: - products required: - collection properties: collection: type: \"Product Collection details.\" $ref: \"#/components/schemas/ProductCollection\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminCurrenciesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }",
"description": "",
"description": "#### Schema AdminCurrenciesListRes type: object required: - currencies - count - offset - limit properties: currencies: type: array description: An array of currency details. items: $ref: \"#/components/schemas/Currency\" count: type: integer description: The total number of items available offset: type: integer description: The number of currencies skipped when retrieving the currencies. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -115,7 +115,7 @@ ___
{
"name": "AdminCurrenciesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCurrenciesRes type: object required: - currency properties: currency: description: Currency details. $ref: \"#/components/schemas/Currency\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx
+7 -7
View File
@@ -60,7 +60,7 @@ Add multiple customers to a customer group.
{
"name": "AdminCustomerGroupsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCustomerGroupsRes type: object required: - customer_group properties: customer_group: description: Customer group details. $ref: \"#/components/schemas/CustomerGroup\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ Create a customer group.
{
"name": "AdminCustomerGroupsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCustomerGroupsRes type: object required: - customer_group properties: customer_group: description: Customer group details. $ref: \"#/components/schemas/CustomerGroup\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ Lists customer groups.
{
"name": "AdminCustomerGroupsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] }",
"description": "",
"description": "#### Schema AdminCustomerGroupsListRes type: object required: - customer_groups - count - offset - limit properties: customer_groups: type: array description: An array of customer group details. items: $ref: \"#/components/schemas/CustomerGroup\" count: type: integer description: The total number of items available offset: type: integer description: The number of customer groups skipped when retrieving the customer groups. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -280,7 +280,7 @@ List and count customers that belong to provided customer groups.
{
"name": "AdminCustomersListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }",
"description": "",
"description": "#### Schema An array of customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -341,7 +341,7 @@ Remove multiple customers from a customer group.
{
"name": "AdminCustomerGroupsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCustomerGroupsRes type: object required: - customer_group properties: customer_group: description: Customer group details. $ref: \"#/components/schemas/CustomerGroup\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -402,7 +402,7 @@ Retrieves a customer group.
{
"name": "AdminCustomerGroupsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCustomerGroupsRes type: object required: - customer_group properties: customer_group: description: Customer group details. $ref: \"#/components/schemas/CustomerGroup\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -463,7 +463,7 @@ Updates a customer group
{
"name": "AdminCustomerGroupsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminCustomerGroupsRes type: object required: - customer_group properties: customer_group: description: Customer group details. $ref: \"#/components/schemas/CustomerGroup\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx
+4 -4
View File
@@ -52,7 +52,7 @@ Creates a customer
{
"name": "AdminCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ Lists customers
{
"name": "AdminCustomersListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }",
"description": "",
"description": "#### Schema An array of customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -158,7 +158,7 @@ Retrieves a customer
{
"name": "AdminCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ Updates a customer
{
"name": "AdminCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx
+14 -14
View File
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -137,7 +137,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -192,7 +192,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -263,7 +263,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -326,7 +326,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -515,7 +515,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -578,7 +578,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -649,7 +649,7 @@ ___
{
"name": "AdminDiscountConditionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount condition details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -704,7 +704,7 @@ ___
{
"name": "AdminDiscountsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] }",
"description": "",
"description": "#### Schema AdminDiscountsListRes type: object x-expanded-relations: field: discounts relations: - parent_discount - regions - rule - rule.conditions required: - discounts - count - offset - limit properties: discounts: type: array items: $ref: \"#/components/schemas/Discount\" count: type: integer description: The total number of items available offset: type: integer description: The number of discounts skipped when retrieving the discounts. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -767,7 +767,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -822,7 +822,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -877,7 +877,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -940,7 +940,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1019,7 +1019,7 @@ ___
{
"name": "AdminDiscountsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Discount details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx
+99 -2
View File
@@ -115,6 +115,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-1.mdx)
- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-2.mdx)
- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-3.mdx)
- [Socket](../../internal/classes/admin_discounts.internal.Socket.mdx)
- [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress.mdx)
- [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx)
- [Stream](../../internal/classes/admin_discounts.internal.Stream.mdx)
@@ -125,6 +126,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Interfaces
- [AddressInfo](../../internal/interfaces/admin_discounts.internal.AddressInfo.mdx)
- [ArrayBufferView](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx)
- [ArrayLike](../../internal/interfaces/admin_discounts.internal.ArrayLike.mdx)
- [AsyncGenerator](../../internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx)
@@ -136,8 +138,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [Buffer](../../internal/interfaces/admin_discounts.internal.Buffer.mdx)
- [BufferConstructor](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx)
- [CallSite](../../internal/interfaces/admin_discounts.internal.CallSite.mdx)
- [ConnectOpts](../../internal/interfaces/admin_discounts.internal.ConnectOpts.mdx)
- [CreateNoteInput](../../internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx)
- [CreateUserInput](../../internal/interfaces/admin_discounts.internal.CreateUserInput.mdx)
- [Dict](../../internal/interfaces/admin_discounts.internal.Dict.mdx)
- [DuplexOptions](../../internal/interfaces/admin_discounts.internal.DuplexOptions.mdx)
- [ErrnoException](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx)
- [Error](../../internal/interfaces/admin_discounts.internal.Error.mdx)
@@ -152,6 +156,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [ISearchService](../../internal/interfaces/admin_discounts.internal.ISearchService.mdx)
- [IStockLocationService](../../internal/interfaces/admin_discounts.internal.IStockLocationService.mdx)
- [ITransactionBaseService](../../internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx)
- [IncomingHttpHeaders](../../internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx)
- [IpcSocketConnectOpts](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx)
- [Iterable](../../internal/interfaces/admin_discounts.internal.Iterable.mdx)
- [IterableIterator](../../internal/interfaces/admin_discounts.internal.IterableIterator.mdx)
- [Iterator](../../internal/interfaces/admin_discounts.internal.Iterator.mdx)
@@ -160,8 +166,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [JoinerServiceConfig](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx)
- [Logger](../../internal/interfaces/admin_discounts.internal.Logger.mdx)
- [LookupOneOptions](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx)
- [LookupOptions](../../internal/interfaces/admin_discounts.internal.LookupOptions.mdx)
- [NumericalComparisonOperator](../../internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx)
- [Object](../../internal/interfaces/admin_discounts.internal.Object.mdx)
- [OnReadOpts](../../internal/interfaces/admin_discounts.internal.OnReadOpts.mdx)
- [PromiseLike](../../internal/interfaces/admin_discounts.internal.PromiseLike.mdx)
- [QueuingStrategy](../../internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx)
- [QueuingStrategySize](../../internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx)
@@ -179,9 +188,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [ReadableWritablePair](../../internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx)
- [SharedArrayBuffer](../../internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx)
- [SharedArrayBufferConstructor](../../internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx)
- [SocketConstructorOpts](../../internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx)
- [StaticEventEmitterOptions](../../internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx)
- [StreamPipeOptions](../../internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx)
- [StringComparisonOperator](../../internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx)
- [TcpSocketConnectOpts](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx)
- [TransformOptions](../../internal/interfaces/admin_discounts.internal.TransformOptions.mdx)
- [UnderlyingByteSource](../../internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx)
- [UnderlyingSink](../../internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx)
@@ -8783,6 +8794,60 @@ ___
___
### LookupFunction
Ƭ **LookupFunction**: (`hostname`: `string`, `options`: [`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx), `callback`: (`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `address`: `string`, `family`: `number`) => `void`) => `void`
#### Type declaration
▸ (`hostname`, `options`, `callback`): `void`
##### Parameters
<ParameterTypes parameters={[
{
"name": "hostname",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "options",
"type": "[`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "callback",
"type": "(`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \\| ``null``, `address`: `string`, `family`: `number`) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
##### Returns
`void`
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### MedusaContainer
Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) }
@@ -8795,6 +8860,12 @@ ___
___
### MiddlewareVerb
Ƭ **MiddlewareVerb**: ``"USE"`` \| ``"ALL"`` \| [`RouteVerb`](admin_discounts.internal.mdx#routeverb)
___
### ModuleDefinition
Ƭ **ModuleDefinition**: `Object`
@@ -8805,7 +8876,7 @@ ___
{
"name": "canOverride",
"type": "`boolean`",
"description": "",
"description": "#### Deprecated property will be removed in future versions",
"optional": true,
"defaultValue": "",
"children": []
@@ -8853,7 +8924,7 @@ ___
{
"name": "isRequired",
"type": "`boolean`",
"description": "",
"description": "#### Deprecated property will be removed in future versions",
"optional": true,
"defaultValue": "",
"children": []
@@ -10255,6 +10326,12 @@ ___
___
### RouteVerb
Ƭ **RouteVerb**: typeof [`HTTP_METHODS`](admin_discounts.internal.mdx#http_methods)[`number`]
___
### SessionOptions
Ƭ **SessionOptions**: `Object`
@@ -10616,6 +10693,18 @@ ___
___
### SocketConnectOpts
Ƭ **SocketConnectOpts**: [`TcpSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx) \| [`IpcSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx)
___
### SocketReadyState
Ƭ **SocketReadyState**: ``"opening"`` \| ``"open"`` \| ``"readOnly"`` \| ``"writeOnly"`` \| ``"closed"``
___
### StagedJobServiceProps
Ƭ **StagedJobServiceProps**: `Object`
@@ -13577,6 +13666,14 @@ ___
___
### HTTP\_METHODS
• `Const` **HTTP\_METHODS**: readonly [``"GET"``, ``"POST"``, ``"PUT"``, ``"PATCH"``, ``"DELETE"``, ``"OPTIONS"``, ``"HEAD"``]
List of all the supported HTTP methods
___
### IdempotencyKeyRepository
• `Const` **IdempotencyKeyRepository**: `Repository`
www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx
+8 -8
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ ___
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -223,7 +223,7 @@ ___
{
"name": "AdminDraftOrdersListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../../internal/classes/admin_collections.internal.DraftOrder.mdx)[] }",
"description": "",
"description": "#### Schema AdminDraftOrdersListRes type: object x-expanded-relations: field: draft_orders relations: - order - cart - cart.items - cart.items.adjustments required: - draft_orders - count - offset - limit properties: draft_orders: type: array description: An array of draft order's details. items: $ref: \"#/components/schemas/DraftOrder\" count: type: integer description: The total number of items available offset: type: integer description: The number of draft orders skipped when retrieving the draft orders. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -278,7 +278,7 @@ ___
{
"name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPostDraftOrdersDraftOrderRegisterPaymentRes type: object required: - order properties: order: description: Order's details. $ref: \"#/components/schemas/Order\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -341,7 +341,7 @@ ___
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -396,7 +396,7 @@ ___
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -459,7 +459,7 @@ ___
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -530,7 +530,7 @@ ___
{
"name": "AdminDraftOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminDraftOrdersRes type: object x-expanded-relations: field: draft_order relations: - order - cart - cart.items - cart.items.adjustments - cart.billing_address - cart.customer - cart.discounts - cart.discounts.rule - cart.items - cart.items.adjustments - cart.payment - cart.payment_sessions - cart.region - cart.region.payment_providers - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.shipping_option eager: - cart.region.fulfillment_providers - cart.region.payment_providers - cart.shipping_methods.shipping_option implicit: - cart.discounts - cart.discounts.rule - cart.gift_cards - cart.items - cart.items.adjustments - cart.items.tax_lines - cart.items.variant - cart.items.variant.product - cart.items.variant.product.profiles - cart.region - cart.region.tax_rates - cart.shipping_address - cart.shipping_methods - cart.shipping_methods.tax_lines totals: - cart.discount_total - cart.gift_card_tax_total - cart.gift_card_total - cart.item_tax_total - cart.refundable_amount - cart.refunded_total - cart.shipping_tax_total - cart.shipping_total - cart.subtotal - cart.tax_total - cart.total - cart.items.discount_total - cart.items.gift_card_total - cart.items.original_tax_total - cart.items.original_total - cart.items.refundable - cart.items.subtotal - cart.items.tax_total - cart.items.total required: - draft_order properties: draft_order: description: Draft order's details. $ref: \"#/components/schemas/DraftOrder\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminGiftCardsRes",
"type": "`object`",
"description": "",
"description": "#### Schema A gift card's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -160,7 +160,7 @@ ___
{
"name": "AdminGiftCardsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `gift_cards`: [`GiftCard`](../../internal/classes/admin_collections.internal.GiftCard.mdx)[] }",
"description": "",
"description": "#### Schema AdminGiftCardsListRes type: object x-expanded-relations: field: gift_cards relations: - order - region eager: - region.fulfillment_providers - region.payment_providers required: - gift_cards - count - offset - limit properties: gift_cards: type: array items: $ref: \"#/components/schemas/GiftCard\" count: type: integer description: The total number of items available offset: type: integer description: The number of gift cards skipped when retrieving the gift cards. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -215,7 +215,7 @@ ___
{
"name": "AdminGiftCardsRes",
"type": "`object`",
"description": "",
"description": "#### Schema A gift card's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -278,7 +278,7 @@ ___
{
"name": "AdminGiftCardsRes",
"type": "`object`",
"description": "",
"description": "#### Schema A gift card's details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx
+8 -8
View File
@@ -62,7 +62,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -137,7 +137,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -271,7 +271,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -330,7 +330,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](../../internal/modules/admin_discounts.internal.internal.mdx#decoratedinventoryitemdto)[] }",
"description": "",
"description": "#### Schema AdminInventoryItemsListWithVariantsAndLocationLevelsRes type: object required: - inventory_items - count - offset - limit properties: inventory_items: type: array description: an array of Inventory Item details items: $ref: \"#/components/schemas/DecoratedInventoryItemDTO\" count: type: integer description: The total number of items available offset: type: integer description: The number of inventory items skipped when retrieving the inventory items. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -397,7 +397,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsLocationLevelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsLocationLevelsRes type: object required: - inventory_item properties: inventory_item: type: object required: - id - location_levels properties: id: description: The id of the location location_levels: description: List of stock levels at a given location type: array items: $ref: \"#/components/schemas/InventoryLevelDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -464,7 +464,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -539,7 +539,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -622,7 +622,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminInventoryItemsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminInventoryItemsRes type: object required: - inventory_item properties: inventory_item: description: Inventory Item details $ref: \"#/components/schemas/InventoryItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx
+1 -1
View File
@@ -177,7 +177,7 @@ ___
{
"name": "AdminListInvitesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminListInvitesRes type: object required: - invites properties: invites: type: array description: An array of invites items: $ref: \"#/components/schemas/Invite\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminNotesRes type: object required: - note properties: note: description: Note details. $ref: \"#/components/schemas/Note\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -152,7 +152,7 @@ ___
{
"name": "AdminNotesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `notes`: [`Note`](../../internal/classes/admin_discounts.internal.internal.Note.mdx)[] }",
"description": "",
"description": "#### Schema AdminNotesListRes type: object required: - notes - count - offset - limit properties: notes: type: array description: An array of notes items: $ref: \"#/components/schemas/Note\" count: type: integer description: The total number of items available offset: type: integer description: The number of notes skipped when retrieving the notes. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -203,7 +203,7 @@ ___
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminNotesRes type: object required: - note properties: note: description: Note details. $ref: \"#/components/schemas/Note\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -262,7 +262,7 @@ ___
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminNotesRes type: object required: - note properties: note: description: Note details. $ref: \"#/components/schemas/Note\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminNotificationsListRes",
"type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../../internal/classes/admin_discounts.internal.internal.Notification.mdx)[] }",
"description": "",
"description": "#### Schema AdminNotificationsListRes type: object x-expanded-relations: field: notifications relations: - resends required: - notifications properties: notifications: type: array description: an array of notifications items: $ref: \"#/components/schemas/Notification\" count: type: integer description: The total number of notifications offset: type: integer description: The number of notifications skipped when retrieving the notifications. limit: type: integer description: The number of notifications per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminNotificationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminNotificationsRes type: object x-expanded-relations: field: notification relations: - resends required: - notification properties: notification: description: Notification details $ref: \"#/components/schemas/Notification\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx
+11 -11
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -160,7 +160,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -211,7 +211,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -321,7 +321,7 @@ ___
{
"name": "AdminOrderEditItemChangeDeleteRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminOrderEditItemChangeDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Order Edit Item Change. object: type: string description: The type of the object that was deleted. default: item_change deleted: type: boolean description: Whether or not the Order Edit Item Change was deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -372,7 +372,7 @@ ___
{
"name": "AdminOrderEditsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `order_edits`: [`OrderEdit`](../../internal/classes/admin_collections.internal.OrderEdit.mdx)[] }",
"description": "",
"description": "#### Schema An array of order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -431,7 +431,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -482,7 +482,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -541,7 +541,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -600,7 +600,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
@@ -667,7 +667,7 @@ ___
{
"name": "AdminOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx
+25 -25
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -160,7 +160,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -286,7 +286,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -345,7 +345,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -404,7 +404,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -471,7 +471,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -522,7 +522,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -573,7 +573,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -632,7 +632,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -699,7 +699,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -758,7 +758,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -817,7 +817,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -876,7 +876,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -943,7 +943,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1010,7 +1010,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1077,7 +1077,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1128,7 +1128,7 @@ ___
{
"name": "AdminOrdersListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx)[] }",
"description": "",
"description": "#### Schema An array of order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1187,7 +1187,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1246,7 +1246,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1305,7 +1305,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1364,7 +1364,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1423,7 +1423,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1490,7 +1490,7 @@ ___
{
"name": "AdminOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminPaymentCollectionDeleteRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPaymentCollectionDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Payment Collection. object: type: string description: The type of the object that was deleted. default: payment_collection deleted: type: boolean description: Whether or not the Payment Collection was deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -101,7 +101,7 @@ ___
{
"name": "AdminPaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - payments - region eager: - region.fulfillment_providers - region.payment_providers required: - payment_collection properties: payment_collection: description: Payment Collection details. $ref: \"#/components/schemas/PaymentCollection\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -160,7 +160,7 @@ ___
{
"name": "AdminPaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - payments - region eager: - region.fulfillment_providers - region.payment_providers required: - payment_collection properties: payment_collection: description: Payment Collection details. $ref: \"#/components/schemas/PaymentCollection\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ ___
{
"name": "AdminPaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPaymentCollectionsRes type: object x-expanded-relations: field: payment_collection relations: - payment_sessions - payments - region eager: - region.fulfillment_providers - region.payment_providers required: - payment_collection properties: payment_collection: description: Payment Collection details. $ref: \"#/components/schemas/PaymentCollection\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx
+3 -3
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminPaymentRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment details",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminRefundRes",
"type": "`object`",
"description": "",
"description": "#### Schema Refund details",
"optional": false,
"defaultValue": "",
"children": []
@@ -168,7 +168,7 @@ ___
{
"name": "AdminPaymentRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment details",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx
+9 -9
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminPriceListRes",
"type": "`object`",
"description": "",
"description": "#### Schema Price List details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminPriceListRes",
"type": "`object`",
"description": "",
"description": "#### Schema Price List details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ ___
{
"name": "AdminPriceListDeleteBatchRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPriceListDeleteBatchRes type: object required: - ids - object - deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -278,7 +278,7 @@ ___
{
"name": "AdminPriceListDeleteBatchRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPriceListDeleteBatchRes type: object required: - ids - object - deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -337,7 +337,7 @@ ___
{
"name": "AdminPriceListDeleteBatchRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPriceListDeleteBatchRes type: object required: - ids - object - deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -396,7 +396,7 @@ ___
{
"name": "AdminPriceListDeleteBatchRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPriceListDeleteBatchRes type: object required: - ids - object - deleted properties: ids: type: array items: type: string description: The IDs of the deleted prices. object: type: string description: The type of the object that was deleted. A price is also named `money-amount`. default: money-amount deleted: type: boolean description: Whether or not the items were deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -447,7 +447,7 @@ ___
{
"name": "AdminPriceListsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `price_lists`: [`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)[] }",
"description": "",
"description": "#### Schema An array of price lists details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -557,7 +557,7 @@ ___
{
"name": "AdminPriceListRes",
"type": "`object`",
"description": "",
"description": "#### Schema Price List details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -616,7 +616,7 @@ ___
{
"name": "AdminPriceListRes",
"type": "`object`",
"description": "",
"description": "#### Schema Price List details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx
+6 -6
View File
@@ -62,7 +62,7 @@ To use this feature please enable featureflag `product_categories` in your medus
{
"name": "AdminProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -117,7 +117,7 @@ ___
{
"name": "AdminProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -231,7 +231,7 @@ To use this feature please enable featureflag `product_categories` in your medus
{
"name": "AdminProductCategoriesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)[] }",
"description": "",
"description": "#### Schema An array of product category details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -298,7 +298,7 @@ To use this feature please enable featureflag `product_categories` in your medus
{
"name": "AdminProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -365,7 +365,7 @@ To use this feature please enable featureflag `product_categories` in your medus
{
"name": "AdminProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -432,7 +432,7 @@ To use this feature please enable featureflag `product_categories` in your medus
{
"name": "AdminProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx
+1 -1
View File
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminProductTagsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)[] }",
"description": "",
"description": "#### Schema An array of product tag details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx
+1 -1
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminProductTypesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)[] }",
"description": "",
"description": "#### Schema AdminProductTypesListRes type: object required: - product_types - count - offset - limit properties: product_types: type: array description: An array of product types details. items: $ref: \"#/components/schemas/ProductType\" count: type: integer description: The total number of items available offset: type: integer description: The number of product types skipped when retrieving the product types. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx
+14 -14
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -168,7 +168,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ ___
{
"name": "AdminProductsDeleteRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsDeleteRes type: object required: - id - object - deleted properties: id: type: string description: The ID of the deleted Product. object: type: string description: The type of the object that was deleted. default: product deleted: type: boolean description: Whether or not the items were deleted. default: true",
"optional": false,
"defaultValue": "",
"children": []
@@ -278,7 +278,7 @@ ___
{
"name": "AdminProductsDeleteOptionRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsDeleteOptionRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - option_id - object - deleted - product properties: option_id: type: string description: The ID of the deleted Product Option object: type: string description: The type of the object that was deleted. default: option deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -337,7 +337,7 @@ ___
{
"name": "AdminProductsDeleteVariantRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsDeleteVariantRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - variant_id - object - deleted - product properties: variant_id: type: string description: The ID of the deleted Product Variant. object: type: string description: The type of the object that was deleted. default: product-variant deleted: type: boolean description: Whether or not the items were deleted. default: true product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -388,7 +388,7 @@ ___
{
"name": "AdminProductsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: ([`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct) \\| [`Product`](../../internal/classes/admin_collections.internal.Product.mdx))[] }",
"description": "",
"description": "#### Schema AdminProductsListRes type: object x-expanded-relations: field: products relations: - collection - images - options - tags - type - variants - variants.options - variants.prices totals: - variants.purchasable required: - products - count - offset - limit properties: products: type: array description: An array of products details. items: $ref: \"#/components/schemas/PricedProduct\" count: type: integer description: The total number of items available offset: type: integer description: The number of products skipped when retrieving the products. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -431,7 +431,7 @@ ___
{
"name": "AdminProductsListTagsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsListTagsRes type: object required: - tags properties: tags: description: An array of product tags details. type: array items: type: object required: - id - usage_count - value properties: id: description: The ID of the tag. type: string usage_count: description: The number of products that use this tag. type: string value: description: The value of the tag. type: string",
"optional": false,
"defaultValue": "",
"children": []
@@ -474,7 +474,7 @@ ___
{
"name": "AdminProductsListTypesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsListTypesRes type: object required: - types properties: types: type: array description: An array of product types details. items: $ref: \"#/components/schemas/ProductType\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -529,7 +529,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -588,7 +588,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -647,7 +647,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -714,7 +714,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -781,7 +781,7 @@ ___
{
"name": "AdminProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminProductsRes type: object x-expanded-relations: field: product relations: - collection - images - options - tags - type - variants - variants.options - variants.prices required: - product properties: product: description: Product details. $ref: \"#/components/schemas/PricedProduct\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx
+7 -7
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminPublishableApiKeysRes",
"type": "`object`",
"description": "",
"description": "#### Schema Publishable API key details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ ___
{
"name": "AdminPublishableApiKeysRes",
"type": "`object`",
"description": "",
"description": "#### Schema Publishable API key details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -219,7 +219,7 @@ ___
{
"name": "AdminPublishableApiKeysRes",
"type": "`object`",
"description": "",
"description": "#### Schema Publishable API key details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -270,7 +270,7 @@ ___
{
"name": "AdminPublishableApiKeysListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../../internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx)[] }",
"description": "",
"description": "#### Schema An array of publishable API keys details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -329,7 +329,7 @@ ___
{
"name": "AdminSalesChannelsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)[] }",
"description": "",
"description": "#### Schema An array of sales channels details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -388,7 +388,7 @@ ___
{
"name": "AdminPublishableApiKeysRes",
"type": "`object`",
"description": "",
"description": "#### Schema Publishable API key details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -439,7 +439,7 @@ ___
{
"name": "AdminPublishableApiKeysRes",
"type": "`object`",
"description": "",
"description": "#### Schema Publishable API key details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx
+1 -1
View File
@@ -538,7 +538,7 @@ ___
{
"name": "AdminRegionsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx)[] }",
"description": "",
"description": "#### Schema An array of regions details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx
+4 -4
View File
@@ -52,7 +52,7 @@ create a reservation
{
"name": "AdminReservationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReservationsRes type: object required: - reservation properties: reservation: description: Reservation details. $ref: \"#/components/schemas/ReservationItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -172,7 +172,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminReservationsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[] }",
"description": "",
"description": "#### Schema AdminReservationsListRes type: object required: - reservations - count - offset - limit properties: reservations: type: array description: An array of reservations details. items: $ref: \"#/components/schemas/ExtendedReservationItem\" count: type: integer description: The total number of items available offset: type: integer description: The number of reservations skipped when retrieving the reservations. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -231,7 +231,7 @@ To use this feature please install @medusajs/inventory
{
"name": "AdminReservationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReservationsRes type: object required: - reservation properties: reservation: description: Reservation details. $ref: \"#/components/schemas/ReservationItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -296,7 +296,7 @@ update a reservation
{
"name": "AdminReservationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReservationsRes type: object required: - reservation properties: reservation: description: Reservation details. $ref: \"#/components/schemas/ReservationItemDTO\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminReturnReasonsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required: - return_reason properties: return_reason: $ref: \"#/components/schemas/ReturnReason\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -152,7 +152,7 @@ ___
{
"name": "AdminReturnReasonsListRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnReasonsListRes type: object x-expanded-relations: field: return_reasons relations: - parent_return_reason - return_reason_children required: - return_reasons properties: return_reasons: type: array items: $ref: \"#/components/schemas/ReturnReason\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -207,7 +207,7 @@ ___
{
"name": "AdminReturnReasonsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required: - return_reason properties: return_reason: $ref: \"#/components/schemas/ReturnReason\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -270,7 +270,7 @@ ___
{
"name": "AdminReturnReasonsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnReasonsRes type: object x-expanded-relations: field: return_reason relations: - parent_return_reason - return_reason_children required: - return_reason properties: return_reason: $ref: \"#/components/schemas/ReturnReason\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx
+3 -3
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminReturnsCancelRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnsCancelRes type: object x-expanded-relations: field: order relations: - billing_address - claims - claims.additional_items - claims.additional_items.variant - claims.claim_items - claims.claim_items.images - claims.claim_items.item - claims.fulfillments - claims.fulfillments.tracking_links - claims.return_order - claims.return_order.shipping_method - claims.return_order.shipping_method.tax_lines - claims.shipping_address - claims.shipping_methods - customer - discounts - discounts.rule - fulfillments - fulfillments.items - fulfillments.tracking_links - gift_card_transactions - gift_cards - items - payments - refunds - region - returns - returns.items - returns.items.reason - returns.shipping_method - returns.shipping_method.tax_lines - shipping_address - shipping_methods - swaps - swaps.additional_items - swaps.additional_items.variant - swaps.fulfillments - swaps.fulfillments.tracking_links - swaps.payment - swaps.return_order - swaps.return_order.shipping_method - swaps.return_order.shipping_method.tax_lines - swaps.shipping_address - swaps.shipping_methods - swaps.shipping_methods.tax_lines required: - order properties: order: description: Order details. $ref: \"#/components/schemas/Order\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "AdminReturnsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `returns`: [`Return`](../../internal/classes/admin_collections.internal.Return.mdx)[] }",
"description": "",
"description": "#### Schema AdminReturnsListRes type: object x-expanded-relation: field: returns relations: - order - swap required: - returns - count - offset - limit properties: returns: type: array description: An array of returns details. items: $ref: \"#/components/schemas/Return\" count: type: integer description: The total number of items available offset: type: integer description: The number of returns skipped when retrieving the returns. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -168,7 +168,7 @@ ___
{
"name": "AdminReturnsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminReturnsRes type: object x-expanded-relation: field: return relations: - swap required: - return properties: return: description: Return details. $ref: \"#/components/schemas/Return\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx
+8 -8
View File
@@ -62,7 +62,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -129,7 +129,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -184,7 +184,7 @@ ___
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -298,7 +298,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)[] }",
"description": "",
"description": "#### Schema An array of sales channels details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -365,7 +365,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -432,7 +432,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -491,7 +491,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -558,7 +558,7 @@ To use this feature please enable featureflag `sales_channels` in your medusa ba
{
"name": "AdminSalesChannelsRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminSalesChannelsRes type: object required: - sales_channel properties: sales_channel: description: Sales Channel's details. $ref: \"#/components/schemas/SalesChannel\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminShippingOptionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Shipping option details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -160,7 +160,7 @@ ___
{
"name": "AdminShippingOptionsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../../internal/classes/admin_collections.internal.ShippingOption.mdx)[] }",
"description": "",
"description": "#### Schema An array of shipping options details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -215,7 +215,7 @@ ___
{
"name": "AdminShippingOptionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Shipping option details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -278,7 +278,7 @@ ___
{
"name": "AdminShippingOptionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Shipping option details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminShippingProfilesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminShippingProfilesRes type: object x-expanded-relations: field: shipping_profile relations: - products - shipping_options required: - shipping_profile properties: shipping_profile: description: Shipping profile details. $ref: \"#/components/schemas/ShippingProfile\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -144,7 +144,7 @@ ___
{
"name": "AdminShippingProfilesListRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminShippingProfilesListRes type: object required: - shipping_profiles properties: shipping_profiles: type: array description: An array of shipping profiles details. items: $ref: \"#/components/schemas/ShippingProfile\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -195,7 +195,7 @@ ___
{
"name": "AdminShippingProfilesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminShippingProfilesRes type: object x-expanded-relations: field: shipping_profile relations: - products - shipping_options required: - shipping_profile properties: shipping_profile: description: Shipping profile details. $ref: \"#/components/schemas/ShippingProfile\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -254,7 +254,7 @@ ___
{
"name": "AdminShippingProfilesRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminShippingProfilesRes type: object x-expanded-relations: field: shipping_profile relations: - products - shipping_options required: - shipping_profile properties: shipping_profile: description: Shipping profile details. $ref: \"#/components/schemas/ShippingProfile\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx
+4 -4
View File
@@ -54,7 +54,7 @@ To use this feature please install @medusajs/stock-location
{
"name": "AdminStockLocationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Stock location details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -172,7 +172,7 @@ To use this feature please install @medusajs/stock-location
{
"name": "AdminStockLocationsListRes",
"type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationexpandeddto)[] }",
"description": "",
"description": "#### Schema AdminStockLocationsListRes type: object required: - stock_locations - count - offset - limit properties: stock_locations: type: array items: $ref: \"#/components/schemas/StockLocationExpandedDTO\" count: type: integer description: The total number of items available offset: type: integer description: The number of stock locations skipped when retrieving the stock locations. limit: type: integer description: The number of items per page",
"optional": false,
"defaultValue": "",
"children": []
@@ -231,7 +231,7 @@ To use this feature please install @medusajs/stock-location
{
"name": "AdminStockLocationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Stock location details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -298,7 +298,7 @@ To use this feature please install @medusajs/stock-location
{
"name": "AdminStockLocationsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Stock location details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx
+6 -6
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminStoresRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminStoresRes type: object required: - store properties: store: description: Store details. $ref: \"#/components/schemas/Store\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "AdminStoresRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminStoresRes type: object required: - store properties: store: description: Store details. $ref: \"#/components/schemas/Store\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -152,7 +152,7 @@ ___
{
"name": "AdminPaymentProvidersList",
"type": "`object`",
"description": "",
"description": "#### Schema AdminPaymentProvidersList type: object required: - payment_providers properties: payment_providers: type: array description: An array of payment providers details. items: $ref: \"#/components/schemas/PaymentProvider\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -199,7 +199,7 @@ ___
{
"name": "AdminTaxProvidersList",
"type": "`object`",
"description": "",
"description": "#### Schema AdminTaxProvidersList type: object required: - tax_providers properties: tax_providers: type: array description: An array of tax providers details. items: $ref: \"#/components/schemas/TaxProvider\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -246,7 +246,7 @@ ___
{
"name": "AdminExtendedStoresRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminExtendedStoresRes type: object x-expanded-relations: field: store relations: - currencies - default_currency required: - store properties: store: description: Store details. $ref: \"#/components/schemas/ExtendedStoreDTO\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -301,7 +301,7 @@ ___
{
"name": "AdminStoresRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminStoresRes type: object required: - store properties: store: description: Store details. $ref: \"#/components/schemas/Store\"",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminSwapsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `swaps`: [`Swap`](../../internal/classes/admin_collections.internal.Swap.mdx)[] }",
"description": "",
"description": "#### Schema An array of swaps details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -101,7 +101,7 @@ ___
{
"name": "AdminSwapsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Swap details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx
+10 -10
View File
@@ -66,7 +66,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -133,7 +133,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -200,7 +200,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -259,7 +259,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -361,7 +361,7 @@ ___
{
"name": "AdminTaxRatesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `tax_rates`: [`TaxRate`](../../internal/classes/admin_collections.internal.TaxRate.mdx)[] }",
"description": "",
"description": "#### Schema An array of tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -428,7 +428,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -495,7 +495,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -562,7 +562,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -621,7 +621,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -688,7 +688,7 @@ ___
{
"name": "AdminTaxRatesRes",
"type": "`object`",
"description": "",
"description": "#### Schema Tax rate details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx
+3 -3
View File
@@ -88,7 +88,7 @@ ___
{
"name": "AdminUploadsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Uploaded files details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -135,7 +135,7 @@ ___
{
"name": "AdminUploadsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Uploaded files details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -241,7 +241,7 @@ ___
{
"name": "AdminUploadsDownloadUrlRes",
"type": "`object`",
"description": "",
"description": "#### Schema AdminUploadsDownloadUrlRes type: object required: - download_url properties: download_url: description: The Download URL of the file type: string",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx
+5 -5
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminUserRes",
"type": "`object`",
"description": "",
"description": "#### Schema User details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -152,7 +152,7 @@ ___
{
"name": "AdminUsersListRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of users details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -207,7 +207,7 @@ ___
{
"name": "AdminUserRes",
"type": "`object`",
"description": "",
"description": "#### Schema User details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -264,7 +264,7 @@ Retrieves a given user
{
"name": "AdminUserRes",
"type": "`object`",
"description": "",
"description": "#### Schema User details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -369,7 +369,7 @@ ___
{
"name": "AdminUserRes",
"type": "`object`",
"description": "",
"description": "#### Schema User details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx
+3 -3
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "AdminGetVariantsVariantInventoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema The product variant's.",
"optional": false,
"defaultValue": "",
"children": []
@@ -103,7 +103,7 @@ List product variants
{
"name": "AdminVariantsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[] }",
"description": "",
"description": "#### Schema An array of product variant details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -164,7 +164,7 @@ Get a product variant
{
"name": "AdminVariantsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product variant's details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx
+4 -4
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -143,7 +143,7 @@ ___
{
"name": "StoreGetAuthEmailRes",
"type": "`object`",
"description": "",
"description": "#### Schema StoreGetAuthEmailRes type: object required: - exists properties: exists: description: Whether email exists or not. type: boolean",
"optional": false,
"defaultValue": "",
"children": []
@@ -190,7 +190,7 @@ ___
{
"name": "StoreAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -246,7 +246,7 @@ ___
{
"name": "StoreBearerAuthRes",
"type": "`object`",
"description": "",
"description": "#### Schema StoreBearerAuthRes type: object properties: accessToken: description: Access token for subsequent authorization. type: string",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx
+11 -11
View File
@@ -73,7 +73,7 @@ Adds a shipping method to cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -130,7 +130,7 @@ If not provided, we will generate one for the request.
{
"name": "StoreCompleteCartRes",
"type": "{ `data`: [`Cart`](../../internal/classes/admin_collections.internal.Cart.mdx) ; `type`: ``\"cart\"`` } \\| { `data`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx) ; `type`: ``\"order\"`` } \\| { `data`: [`Swap`](../../internal/classes/admin_collections.internal.Swap.mdx) ; `type`: ``\"swap\"`` }",
"description": "",
"description": "#### Schema StoreCompleteCartRes type: object required: - type - data properties: type: type: string description: \"The type of the data property. If the cart completion fails, type will be `cart` and the data object will be the cart's details. If the cart completion is successful and the cart is used for checkout, type will be `order` and the data object will be the order's details. If the cart completion is successful and the cart is used for swap creation, type will be `swap` and the data object will be the swap's details.\" enum: [order, cart, swap] data: type: object description: The data of the result object. Its type depends on the type field. oneOf: - type: object allOf: - description: Cart was successfully authorized and order was placed successfully. - $ref: \"#/components/schemas/Order\" - type: object allOf: - description: Cart was successfully authorized but requires further actions. - $ref: \"#/components/schemas/Cart\" - type: object allOf: - description: Cart was used for a swap and it has been completed successfully. - $ref: \"#/components/schemas/Swap\"",
"optional": false,
"defaultValue": "",
"children": []
@@ -183,7 +183,7 @@ Creates a cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -238,7 +238,7 @@ This is usually called when a customer proceeds to checkout.
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -299,7 +299,7 @@ Removes a discount from cart.
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -361,7 +361,7 @@ Can be useful in case a payment has failed
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -422,7 +422,7 @@ Refreshes a payment session.
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -475,7 +475,7 @@ Retrieves a cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -536,7 +536,7 @@ Refreshes a payment session.
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -597,7 +597,7 @@ Updates a cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -666,7 +666,7 @@ Updates the payment method
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreCollectionsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }",
"description": "",
"description": "#### Schema An array of product collections details",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "StoreCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product collection details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx
+5 -5
View File
@@ -73,7 +73,7 @@ Creates a customer
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -171,7 +171,7 @@ Retrieve customer orders
{
"name": "StoreCustomersListOrdersRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx)[] }",
"description": "",
"description": "#### Schema An array of orders details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -224,7 +224,7 @@ Resets customer password
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -269,7 +269,7 @@ Retrieves the customer that is currently logged
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -322,7 +322,7 @@ Updates a customer
{
"name": "StoreCustomersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Customer details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx
+1 -1
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreGiftCardsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Gift card details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx
+21 -21
View File
@@ -18,7 +18,7 @@ v0.9.4
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -26,7 +26,7 @@ v0.9.4
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `writable.destroy()` has been called.",
"description": "Is `true` after `writable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -34,7 +34,7 @@ v0.9.4
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -42,7 +42,7 @@ v0.9.4
{
"name": "writable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended.",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -50,7 +50,7 @@ v0.9.4
{
"name": "writableCorked",
"type": "`number`",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream.",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream. #### Since v13.2.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -58,7 +58,7 @@ v0.9.4
{
"name": "writableEnded",
"type": "`boolean`",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -66,7 +66,7 @@ v0.9.4
{
"name": "writableFinished",
"type": "`boolean`",
"description": "Is set to `true` immediately before the `'finish'` event is emitted.",
"description": "Is set to `true` immediately before the `'finish'` event is emitted. #### Since v12.6.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -74,7 +74,7 @@ v0.9.4
{
"name": "writableHighWaterMark",
"type": "`number`",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`.",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -82,7 +82,7 @@ v0.9.4
{
"name": "writableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -90,7 +90,7 @@ v0.9.4
{
"name": "writableNeedDrain",
"type": "`boolean`",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`.",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`. #### Since v15.2.0, v14.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -98,15 +98,15 @@ v0.9.4
{
"name": "writableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Writable` stream.",
"description": "Getter for the property `objectMode` of a given `Writable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -114,7 +114,7 @@ v0.9.4
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -122,15 +122,15 @@ v0.9.4
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](../../internal/classes/admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](../../internal/classes/admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -673,7 +673,7 @@ ___
▸ **cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](admin_discounts.internal.internal-2.Writable.mdx#end) methods are called.
The buffered data will be flushed when either the [uncork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#uncork) or [end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) methods are called.
The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
@@ -1089,7 +1089,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the [write](admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](admin_discounts.internal.internal-2.Writable.mdx#end) will raise an error.
Calling the [write](../../internal/classes/admin_discounts.internal.WritableBase.mdx#write) method after calling [end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) will raise an error.
```js
// Write 'hello, ' and then end with 'world!'.
@@ -3414,7 +3414,7 @@ ___
▸ **uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.internal-2.Writable.mdx#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#cork) was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
@@ -3503,7 +3503,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../../internal/classes/admin_discounts.internal.PassThrough.mdx#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../../internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:
```js
www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx
+16
View File
@@ -237,6 +237,14 @@ Base abstract entity for all entities
"defaultValue": "",
"children": []
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "items",
"type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]",
@@ -397,6 +405,14 @@ Base abstract entity for all entities
"defaultValue": "",
"children": []
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "shipping_total",
"type": "`number`",
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx
+2 -2
View File
@@ -21,7 +21,7 @@ v15.7.0, v14.18.0
{
"name": "size",
"type": "`number`",
"description": "The total size of the `Blob` in bytes.",
"description": "The total size of the `Blob` in bytes. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -29,7 +29,7 @@ v15.7.0, v14.18.0
{
"name": "type",
"type": "`string`",
"description": "The content-type of the `Blob`.",
"description": "The content-type of the `Blob`. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx
+38 -38
View File
@@ -30,7 +30,7 @@ v0.9.4
{
"name": "allowHalfOpen",
"type": "`boolean`",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted.",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted. #### Since v0.9.4",
"optional": false,
"defaultValue": "",
"children": []
@@ -38,7 +38,7 @@ v0.9.4
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -46,7 +46,7 @@ v0.9.4
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `readable.destroy()` has been called.",
"description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -54,7 +54,7 @@ v0.9.4
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -62,7 +62,7 @@ v0.9.4
{
"name": "readable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`.",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -70,7 +70,7 @@ v0.9.4
{
"name": "readableAborted",
"type": "`boolean`",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`.",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -78,7 +78,7 @@ v0.9.4
{
"name": "readableDidRead",
"type": "`boolean`",
"description": "Returns whether `'data'` has been emitted.",
"description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -86,7 +86,7 @@ v0.9.4
{
"name": "readableEncoding",
"type": "``null`` \\| [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. #### Since v12.7.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -94,7 +94,7 @@ v0.9.4
{
"name": "readableEnded",
"type": "`boolean`",
"description": "Becomes `true` when `'end'` event is emitted.",
"description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -102,7 +102,7 @@ v0.9.4
{
"name": "readableFlowing",
"type": "``null`` \\| `boolean`",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -110,7 +110,7 @@ v0.9.4
{
"name": "readableHighWaterMark",
"type": "`number`",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`.",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -118,7 +118,7 @@ v0.9.4
{
"name": "readableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -126,7 +126,7 @@ v0.9.4
{
"name": "readableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Readable` stream.",
"description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -134,7 +134,7 @@ v0.9.4
{
"name": "writable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended.",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -142,7 +142,7 @@ v0.9.4
{
"name": "writableCorked",
"type": "`number`",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream.",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream. #### Since v13.2.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -150,7 +150,7 @@ v0.9.4
{
"name": "writableEnded",
"type": "`boolean`",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -158,7 +158,7 @@ v0.9.4
{
"name": "writableFinished",
"type": "`boolean`",
"description": "Is set to `true` immediately before the `'finish'` event is emitted.",
"description": "Is set to `true` immediately before the `'finish'` event is emitted. #### Since v12.6.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -166,7 +166,7 @@ v0.9.4
{
"name": "writableHighWaterMark",
"type": "`number`",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`.",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -174,7 +174,7 @@ v0.9.4
{
"name": "writableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -182,7 +182,7 @@ v0.9.4
{
"name": "writableNeedDrain",
"type": "`boolean`",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`.",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`. #### Since v15.2.0, v14.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -190,15 +190,15 @@ v0.9.4
{
"name": "writableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Writable` stream.",
"description": "Getter for the property `objectMode` of a given `Writable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -206,7 +206,7 @@ v0.9.4
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -214,15 +214,15 @@ v0.9.4
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -1108,7 +1108,7 @@ ___
▸ **cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) methods are called.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called.
The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
@@ -1749,7 +1749,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the [write](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) will raise an error.
Calling the [write](admin_discounts.internal.WritableBase.mdx#write) method after calling [end](admin_discounts.internal.WritableBase.mdx#end) will raise an error.
```js
// Write 'hello, ' and then end with 'world!'.
@@ -4816,7 +4816,7 @@ a call to `readable.read(size)`, regardless of the value of the`size` argument.
If the `readable.read()` method returns a chunk of data, a `'data'` event will
also be emitted.
Calling [read](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has
Calling [read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#read) after the `'end'` event has
been emitted will return `null`. No runtime error will be raised.
#### Parameters
@@ -5760,7 +5760,7 @@ ___
▸ **uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.WritableBase.mdx#cork) was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
@@ -5821,7 +5821,7 @@ ___
▸ **unpipe**(`destination?`): [`Duplex`](admin_discounts.internal.Duplex.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.PassThrough.mdx#pipe) method.
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
If the `destination` is not specified, then _all_ pipes are detached.
@@ -5937,11 +5937,11 @@ function parseHeader(stream, callback) {
}
```
Unlike [push](admin_discounts.internal.PassThrough.mdx#push), `stream.unshift(chunk)` will not
Unlike [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push), `stream.unshift(chunk)` will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if `readable.unshift()` is called during a
read (i.e. from within a [_read](admin_discounts.internal.PassThrough.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#push) will reset the reading state appropriately,
read (i.e. from within a [_read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push) will reset the reading state appropriately,
however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read.
@@ -5998,7 +5998,7 @@ ___
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
When using an older Node.js library that emits `'data'` events and has a [pause](admin_discounts.internal.PassThrough.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
When using an older Node.js library that emits `'data'` events and has a [pause](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
stream that uses
the old stream as its data source.
@@ -6088,7 +6088,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](admin_discounts.internal.PassThrough.mdx#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:
```js
@@ -6231,7 +6231,7 @@ A utility method for creating duplex streams.
<ParameterTypes parameters={[
{
"name": "src",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| `ArrayBuffer` \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx
+6 -6
View File
@@ -28,8 +28,8 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -37,7 +37,7 @@ v0.1.26
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -45,15 +45,15 @@ v0.1.26
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx
+1 -1
View File
@@ -85,7 +85,7 @@ ___
{
"name": "FeatureFlagsResponse",
"type": "{ `key`: `string` ; `value`: `boolean` \\| Record<`string`, `boolean`\\> }[]",
"description": "",
"description": "#### Schema FeatureFlagsResponse type: array items: type: object required: - key - value properties: key: description: The key of the feature flag. type: string value: description: The value of the feature flag. type: boolean",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx
+1 -1
View File
@@ -176,7 +176,7 @@ Standardized error to be used across Medusa project.
{
"name": "prepareStackTrace",
"type": "(`err`: [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error), `stackTraces`: [`CallSite`](../interfaces/admin_discounts.internal.CallSite.mdx)[]) => `any`",
"description": "Optional override for formatting stack traces",
"description": "Optional override for formatting stack traces #### See https://v8.dev/docs/stack-trace-api#customizing-stack-traces",
"optional": true,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx
+38 -38
View File
@@ -17,7 +17,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "allowHalfOpen",
"type": "`boolean`",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted.",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted. #### Since v0.9.4",
"optional": false,
"defaultValue": "",
"children": []
@@ -25,7 +25,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -33,7 +33,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `readable.destroy()` has been called.",
"description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -41,7 +41,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -49,7 +49,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`.",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -57,7 +57,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableAborted",
"type": "`boolean`",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`.",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -65,7 +65,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableDidRead",
"type": "`boolean`",
"description": "Returns whether `'data'` has been emitted.",
"description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -73,7 +73,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableEncoding",
"type": "``null`` \\| [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. #### Since v12.7.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -81,7 +81,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableEnded",
"type": "`boolean`",
"description": "Becomes `true` when `'end'` event is emitted.",
"description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -89,7 +89,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableFlowing",
"type": "``null`` \\| `boolean`",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -97,7 +97,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableHighWaterMark",
"type": "`number`",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`.",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "readableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Readable` stream.",
"description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -121,7 +121,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended.",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -129,7 +129,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableCorked",
"type": "`number`",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream.",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream. #### Since v13.2.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -137,7 +137,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableEnded",
"type": "`boolean`",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -145,7 +145,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableFinished",
"type": "`boolean`",
"description": "Is set to `true` immediately before the `'finish'` event is emitted.",
"description": "Is set to `true` immediately before the `'finish'` event is emitted. #### Since v12.6.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -153,7 +153,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableHighWaterMark",
"type": "`number`",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`.",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -161,7 +161,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -169,7 +169,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableNeedDrain",
"type": "`boolean`",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`.",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`. #### Since v15.2.0, v14.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -177,15 +177,15 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "writableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Writable` stream.",
"description": "Getter for the property `objectMode` of a given `Writable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -193,7 +193,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -201,15 +201,15 @@ primarily for examples and testing, but there are some use cases where`stream.Pa
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -1131,7 +1131,7 @@ ___
▸ **cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) methods are called.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called.
The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
@@ -1720,7 +1720,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the [write](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) will raise an error.
Calling the [write](admin_discounts.internal.WritableBase.mdx#write) method after calling [end](admin_discounts.internal.WritableBase.mdx#end) will raise an error.
```js
// Write 'hello, ' and then end with 'world!'.
@@ -4567,7 +4567,7 @@ a call to `readable.read(size)`, regardless of the value of the`size` argument.
If the `readable.read()` method returns a chunk of data, a `'data'` event will
also be emitted.
Calling [read](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has
Calling [read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#read) after the `'end'` event has
been emitted will return `null`. No runtime error will be raised.
#### Parameters
@@ -5455,7 +5455,7 @@ ___
▸ **uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.WritableBase.mdx#cork) was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
@@ -5516,7 +5516,7 @@ ___
▸ **unpipe**(`destination?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.PassThrough.mdx#pipe) method.
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
If the `destination` is not specified, then _all_ pipes are detached.
@@ -5632,11 +5632,11 @@ function parseHeader(stream, callback) {
}
```
Unlike [push](admin_discounts.internal.PassThrough.mdx#push), `stream.unshift(chunk)` will not
Unlike [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push), `stream.unshift(chunk)` will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if `readable.unshift()` is called during a
read (i.e. from within a [_read](admin_discounts.internal.PassThrough.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#push) will reset the reading state appropriately,
read (i.e. from within a [_read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push) will reset the reading state appropriately,
however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read.
@@ -5693,7 +5693,7 @@ ___
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
When using an older Node.js library that emits `'data'` events and has a [pause](admin_discounts.internal.PassThrough.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
When using an older Node.js library that emits `'data'` events and has a [pause](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
stream that uses
the old stream as its data source.
@@ -5783,7 +5783,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](admin_discounts.internal.PassThrough.mdx#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:
```js
@@ -5926,7 +5926,7 @@ A utility method for creating duplex streams.
<ParameterTypes parameters={[
{
"name": "src",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| `ArrayBuffer` \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx
+24 -24
View File
@@ -18,7 +18,7 @@ v0.9.4
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -26,7 +26,7 @@ v0.9.4
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `readable.destroy()` has been called.",
"description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -34,7 +34,7 @@ v0.9.4
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -42,7 +42,7 @@ v0.9.4
{
"name": "readable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`.",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -50,7 +50,7 @@ v0.9.4
{
"name": "readableAborted",
"type": "`boolean`",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`.",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -58,7 +58,7 @@ v0.9.4
{
"name": "readableDidRead",
"type": "`boolean`",
"description": "Returns whether `'data'` has been emitted.",
"description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -66,7 +66,7 @@ v0.9.4
{
"name": "readableEncoding",
"type": "``null`` \\| [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. #### Since v12.7.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -74,7 +74,7 @@ v0.9.4
{
"name": "readableEnded",
"type": "`boolean`",
"description": "Becomes `true` when `'end'` event is emitted.",
"description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -82,7 +82,7 @@ v0.9.4
{
"name": "readableFlowing",
"type": "``null`` \\| `boolean`",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -90,7 +90,7 @@ v0.9.4
{
"name": "readableHighWaterMark",
"type": "`number`",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`.",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -98,7 +98,7 @@ v0.9.4
{
"name": "readableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -106,15 +106,15 @@ v0.9.4
{
"name": "readableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Readable` stream.",
"description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -122,7 +122,7 @@ v0.9.4
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -130,15 +130,15 @@ v0.9.4
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -3079,7 +3079,7 @@ a call to `readable.read(size)`, regardless of the value of the`size` argument.
If the `readable.read()` method returns a chunk of data, a `'data'` event will
also be emitted.
Calling [read](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has
Calling [read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#read) after the `'end'` event has
been emitted will return `null`. No runtime error will be raised.
#### Parameters
@@ -3756,7 +3756,7 @@ ___
▸ **unpipe**(`destination?`): [`Readable`](admin_discounts.internal.Readable.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.PassThrough.mdx#pipe) method.
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
If the `destination` is not specified, then _all_ pipes are detached.
@@ -3872,11 +3872,11 @@ function parseHeader(stream, callback) {
}
```
Unlike [push](admin_discounts.internal.PassThrough.mdx#push), `stream.unshift(chunk)` will not
Unlike [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push), `stream.unshift(chunk)` will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if `readable.unshift()` is called during a
read (i.e. from within a [_read](admin_discounts.internal.PassThrough.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#push) will reset the reading state appropriately,
read (i.e. from within a [_read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push) will reset the reading state appropriately,
however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read.
@@ -3933,7 +3933,7 @@ ___
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
When using an older Node.js library that emits `'data'` events and has a [pause](admin_discounts.internal.PassThrough.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
When using an older Node.js library that emits `'data'` events and has a [pause](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
stream that uses
the old stream as its data source.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx
+24 -24
View File
@@ -33,7 +33,7 @@ v0.1.26
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -41,7 +41,7 @@ v0.1.26
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `readable.destroy()` has been called.",
"description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -49,7 +49,7 @@ v0.1.26
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -57,7 +57,7 @@ v0.1.26
{
"name": "readable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`.",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -65,7 +65,7 @@ v0.1.26
{
"name": "readableAborted",
"type": "`boolean`",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`.",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -73,7 +73,7 @@ v0.1.26
{
"name": "readableDidRead",
"type": "`boolean`",
"description": "Returns whether `'data'` has been emitted.",
"description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -81,7 +81,7 @@ v0.1.26
{
"name": "readableEncoding",
"type": "``null`` \\| [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. #### Since v12.7.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -89,7 +89,7 @@ v0.1.26
{
"name": "readableEnded",
"type": "`boolean`",
"description": "Becomes `true` when `'end'` event is emitted.",
"description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -97,7 +97,7 @@ v0.1.26
{
"name": "readableFlowing",
"type": "``null`` \\| `boolean`",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ v0.1.26
{
"name": "readableHighWaterMark",
"type": "`number`",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`.",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ v0.1.26
{
"name": "readableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -121,15 +121,15 @@ v0.1.26
{
"name": "readableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Readable` stream.",
"description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -137,7 +137,7 @@ v0.1.26
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -145,15 +145,15 @@ v0.1.26
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -3294,7 +3294,7 @@ a call to `readable.read(size)`, regardless of the value of the`size` argument.
If the `readable.read()` method returns a chunk of data, a `'data'` event will
also be emitted.
Calling [read](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has
Calling [read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#read) after the `'end'` event has
been emitted will return `null`. No runtime error will be raised.
#### Parameters
@@ -4011,7 +4011,7 @@ ___
▸ **unpipe**(`destination?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.PassThrough.mdx#pipe) method.
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
If the `destination` is not specified, then _all_ pipes are detached.
@@ -4127,11 +4127,11 @@ function parseHeader(stream, callback) {
}
```
Unlike [push](admin_discounts.internal.PassThrough.mdx#push), `stream.unshift(chunk)` will not
Unlike [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push), `stream.unshift(chunk)` will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if `readable.unshift()` is called during a
read (i.e. from within a [_read](admin_discounts.internal.PassThrough.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#push) will reset the reading state appropriately,
read (i.e. from within a [_read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push) will reset the reading state appropriately,
however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read.
@@ -4188,7 +4188,7 @@ ___
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
When using an older Node.js library that emits `'data'` events and has a [pause](admin_discounts.internal.PassThrough.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
When using an older Node.js library that emits `'data'` events and has a [pause](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
stream that uses
the old stream as its data source.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx
+6598
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx
+6 -6
View File
@@ -28,8 +28,8 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -37,7 +37,7 @@ v0.1.26
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -45,15 +45,15 @@ v0.1.26
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx
+38 -38
View File
@@ -27,7 +27,7 @@ v0.9.4
{
"name": "allowHalfOpen",
"type": "`boolean`",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted.",
"description": "If `false` then the stream will automatically end the writable side when the readable side ends. Set initially by the `allowHalfOpen` constructor option, which defaults to `true`. This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is emitted. #### Since v0.9.4",
"optional": false,
"defaultValue": "",
"children": []
@@ -35,7 +35,7 @@ v0.9.4
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -43,7 +43,7 @@ v0.9.4
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `readable.destroy()` has been called.",
"description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -51,7 +51,7 @@ v0.9.4
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -59,7 +59,7 @@ v0.9.4
{
"name": "readable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`.",
"description": "Is `true` if it is safe to call `readable.read()`, which means the stream has not been destroyed or emitted `'error'` or `'end'`. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -67,7 +67,7 @@ v0.9.4
{
"name": "readableAborted",
"type": "`boolean`",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`.",
"description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -75,7 +75,7 @@ v0.9.4
{
"name": "readableDidRead",
"type": "`boolean`",
"description": "Returns whether `'data'` has been emitted.",
"description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -83,7 +83,7 @@ v0.9.4
{
"name": "readableEncoding",
"type": "``null`` \\| [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.",
"description": "Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. #### Since v12.7.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -91,7 +91,7 @@ v0.9.4
{
"name": "readableEnded",
"type": "`boolean`",
"description": "Becomes `true` when `'end'` event is emitted.",
"description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -99,7 +99,7 @@ v0.9.4
{
"name": "readableFlowing",
"type": "``null`` \\| `boolean`",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section.",
"description": "This property reflects the current state of a `Readable` stream as described in the `Three states` section. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -107,7 +107,7 @@ v0.9.4
{
"name": "readableHighWaterMark",
"type": "`number`",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`.",
"description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -115,7 +115,7 @@ v0.9.4
{
"name": "readableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -123,7 +123,7 @@ v0.9.4
{
"name": "readableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Readable` stream.",
"description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -131,7 +131,7 @@ v0.9.4
{
"name": "writable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended.",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -139,7 +139,7 @@ v0.9.4
{
"name": "writableCorked",
"type": "`number`",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream.",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream. #### Since v13.2.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -147,7 +147,7 @@ v0.9.4
{
"name": "writableEnded",
"type": "`boolean`",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -155,7 +155,7 @@ v0.9.4
{
"name": "writableFinished",
"type": "`boolean`",
"description": "Is set to `true` immediately before the `'finish'` event is emitted.",
"description": "Is set to `true` immediately before the `'finish'` event is emitted. #### Since v12.6.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -163,7 +163,7 @@ v0.9.4
{
"name": "writableHighWaterMark",
"type": "`number`",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`.",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -171,7 +171,7 @@ v0.9.4
{
"name": "writableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -179,7 +179,7 @@ v0.9.4
{
"name": "writableNeedDrain",
"type": "`boolean`",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`.",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`. #### Since v15.2.0, v14.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -187,15 +187,15 @@ v0.9.4
{
"name": "writableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Writable` stream.",
"description": "Getter for the property `objectMode` of a given `Writable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -203,7 +203,7 @@ v0.9.4
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -211,15 +211,15 @@ v0.9.4
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -1133,7 +1133,7 @@ ___
▸ **cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) methods are called.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called.
The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
@@ -1722,7 +1722,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the [write](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) will raise an error.
Calling the [write](admin_discounts.internal.WritableBase.mdx#write) method after calling [end](admin_discounts.internal.WritableBase.mdx#end) will raise an error.
```js
// Write 'hello, ' and then end with 'world!'.
@@ -4569,7 +4569,7 @@ a call to `readable.read(size)`, regardless of the value of the`size` argument.
If the `readable.read()` method returns a chunk of data, a `'data'` event will
also be emitted.
Calling [read](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has
Calling [read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#read) after the `'end'` event has
been emitted will return `null`. No runtime error will be raised.
#### Parameters
@@ -5457,7 +5457,7 @@ ___
▸ **uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.WritableBase.mdx#cork) was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
@@ -5518,7 +5518,7 @@ ___
▸ **unpipe**(`destination?`): [`Transform`](admin_discounts.internal.Transform.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](admin_discounts.internal.PassThrough.mdx#pipe) method.
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
If the `destination` is not specified, then _all_ pipes are detached.
@@ -5634,11 +5634,11 @@ function parseHeader(stream, callback) {
}
```
Unlike [push](admin_discounts.internal.PassThrough.mdx#push), `stream.unshift(chunk)` will not
Unlike [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push), `stream.unshift(chunk)` will not
end the reading process by resetting the internal reading state of the stream.
This can cause unexpected results if `readable.unshift()` is called during a
read (i.e. from within a [_read](admin_discounts.internal.PassThrough.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#push) will reset the reading state appropriately,
read (i.e. from within a [_read](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#_read) implementation on a
custom stream). Following the call to `readable.unshift()` with an immediate [push](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#push) will reset the reading state appropriately,
however it is best to simply avoid calling `readable.unshift()` while in the
process of performing a read.
@@ -5695,7 +5695,7 @@ ___
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
When using an older Node.js library that emits `'data'` events and has a [pause](admin_discounts.internal.PassThrough.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
When using an older Node.js library that emits `'data'` events and has a [pause](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
stream that uses
the old stream as its data source.
@@ -5785,7 +5785,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](admin_discounts.internal.PassThrough.mdx#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:
```js
@@ -5928,7 +5928,7 @@ A utility method for creating duplex streams.
<ParameterTypes parameters={[
{
"name": "src",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"type": "`string` \\| [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) \\| `Promise`<`any`\\> \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| `ArrayBuffer` \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx
+21 -21
View File
@@ -37,7 +37,7 @@ v0.1.26
{
"name": "closed",
"type": "`boolean`",
"description": "Is `true` after `'close'` has been emitted.",
"description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -45,7 +45,7 @@ v0.1.26
{
"name": "destroyed",
"type": "`boolean`",
"description": "Is `true` after `writable.destroy()` has been called.",
"description": "Is `true` after `writable.destroy()` has been called. #### Since v8.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -53,7 +53,7 @@ v0.1.26
{
"name": "errored",
"type": "``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)",
"description": "Returns error if the stream has been destroyed with an error.",
"description": "Returns error if the stream has been destroyed with an error. #### Since v18.0.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -61,7 +61,7 @@ v0.1.26
{
"name": "writable",
"type": "`boolean`",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended.",
"description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended. #### Since v11.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -69,7 +69,7 @@ v0.1.26
{
"name": "writableCorked",
"type": "`number`",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream.",
"description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream. #### Since v13.2.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -77,7 +77,7 @@ v0.1.26
{
"name": "writableEnded",
"type": "`boolean`",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.",
"description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. #### Since v12.9.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -85,7 +85,7 @@ v0.1.26
{
"name": "writableFinished",
"type": "`boolean`",
"description": "Is set to `true` immediately before the `'finish'` event is emitted.",
"description": "Is set to `true` immediately before the `'finish'` event is emitted. #### Since v12.6.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -93,7 +93,7 @@ v0.1.26
{
"name": "writableHighWaterMark",
"type": "`number`",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`.",
"description": "Return the value of `highWaterMark` passed when creating this `Writable`. #### Since v9.3.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -101,7 +101,7 @@ v0.1.26
{
"name": "writableLength",
"type": "`number`",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`.",
"description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`. #### Since v9.4.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -109,7 +109,7 @@ v0.1.26
{
"name": "writableNeedDrain",
"type": "`boolean`",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`.",
"description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`. #### Since v15.2.0, v14.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -117,15 +117,15 @@ v0.1.26
{
"name": "writableObjectMode",
"type": "`boolean`",
"description": "Getter for the property `objectMode` of a given `Writable` stream.",
"description": "Getter for the property `objectMode` of a given `Writable` stream. #### Since v12.3.0",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -133,7 +133,7 @@ v0.1.26
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -141,15 +141,15 @@ v0.1.26
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -700,7 +700,7 @@ ___
▸ **cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) methods are called.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called.
The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
@@ -1136,7 +1136,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.
Calling the [write](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#end) will raise an error.
Calling the [write](admin_discounts.internal.WritableBase.mdx#write) method after calling [end](admin_discounts.internal.WritableBase.mdx#end) will raise an error.
```js
// Write 'hello, ' and then end with 'world!'.
@@ -3629,7 +3629,7 @@ ___
▸ **uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.WritableBase.mdx#cork) was called.
When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
@@ -3714,7 +3714,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.
If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](admin_discounts.internal.PassThrough.mdx#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:
```js
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx
+6 -6
View File
@@ -28,8 +28,8 @@ v0.1.26
<ParameterTypes parameters={[
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.PassThrough.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"type": "typeof [`captureRejectionSymbol`](admin_discounts.internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -37,7 +37,7 @@ v0.1.26
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects. #### Since v13.4.0, v12.16.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -45,15 +45,15 @@ v0.1.26
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. #### Since v0.11.2",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"type": "typeof [`errorMonitor`](admin_discounts.internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed. #### Since v13.6.0, v12.17.0",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx
+1 -1
View File
@@ -164,7 +164,7 @@ The title of the Product`published`.
"name": "status",
"type": "[`ProductStatus`](../enums/admin_collections.internal.ProductStatus.mdx)",
"description": "",
"optional": true,
"optional": false,
"defaultValue": "",
"children": []
},
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx
+3 -3
View File
@@ -651,7 +651,7 @@ Gets the prices for a shipping option.
{
"name": "PricedShippingOption",
"type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\> & [`ShippingOptionPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingoptionpricing)",
"description": "",
"description": "#### Schema PricedShippingOption title: \"Priced Shipping Option\" type: object allOf: - $ref: \"#/components/schemas/ShippingOption\" - type: object properties: price_incl_tax: type: number description: Price including taxes tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate tax_amount: type: number description: The taxes applied.",
"optional": false,
"defaultValue": "",
"children": []
@@ -773,7 +773,7 @@ Set additional prices on a list of shipping options.
{
"name": "PricedShippingOption",
"type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\> & [`ShippingOptionPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingoptionpricing)",
"description": "",
"description": "#### Schema PricedShippingOption title: \"Priced Shipping Option\" type: object allOf: - $ref: \"#/components/schemas/ShippingOption\" - type: object properties: price_incl_tax: type: number description: Price including taxes tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate tax_amount: type: number description: The taxes applied.",
"optional": false,
"defaultValue": "",
"children": []
@@ -835,7 +835,7 @@ Set additional prices on a list of product variants.
{
"name": "PricedVariant",
"type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\> & [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)",
"description": "",
"description": "#### Schema PricedVariant title: \"Priced Product Variant\" type: object allOf: - $ref: \"#/components/schemas/ProductVariant\" - type: object properties: original_price: type: number description: The original price of the variant without any discounted prices applied. calculated_price: type: number description: The calculated price of the variant. Can be a discounted price. original_price_incl_tax: type: number description: The original price of the variant including taxes. calculated_price_incl_tax: type: number description: The calculated price of the variant including taxes. original_tax: type: number description: The taxes applied on the original price. calculated_tax: type: number description: The taxes applied on the calculated price. tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx
+1 -1
View File
@@ -821,7 +821,7 @@ lists inventory items for a given variant
{
"name": "InventoryItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Title of the inventory item",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx
+1 -1
View File
@@ -64,7 +64,7 @@ Finds tax providers and assists in tax related operations.
{
"name": "getCacheKey",
"type": "`any`",
"description": "The cache key to get cache hits by.",
"description": "The cache key to get cache hits by. #### Param the entity id to cache #### Param the region id to cache",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AddressInfo.mdx
+38
View File
@@ -0,0 +1,38 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AddressInfo
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AddressInfo
## Properties
<ParameterTypes parameters={[
{
"name": "address",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "family",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "port",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx
+1 -1
View File
@@ -14,7 +14,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "encoding",
"type": "[`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)",
"description": "",
"description": "#### Default ```ts 'utf8' ```",
"optional": true,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx
+1 -1
View File
@@ -18,7 +18,7 @@ Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'bas
{
"name": "poolSize",
"type": "`number`",
"description": "This is the size (in bytes) of pre-allocated internal `Buffer` instances used for pooling. This value may be modified.",
"description": "This is the size (in bytes) of pre-allocated internal `Buffer` instances used for pooling. This value may be modified. #### Since v0.11.3",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ConnectOpts.mdx
+22
View File
@@ -0,0 +1,22 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ConnectOpts
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ConnectOpts
## Properties
<ParameterTypes parameters={[
{
"name": "onread",
"type": "[`OnReadOpts`](admin_discounts.internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Dict.mdx
+26
View File
@@ -0,0 +1,26 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# Dict
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Dict
## Type parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Indexable
▪ [key: `string`]: `T` \| `undefined`
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx
+56 -14
View File
@@ -87,7 +87,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -205,7 +205,7 @@ ___
{
"name": "InventoryItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Title of the inventory item",
"optional": false,
"defaultValue": "",
"children": []
@@ -263,7 +263,7 @@ ___
{
"name": "InventoryItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Title of the inventory item",
"optional": false,
"defaultValue": "",
"children": []
@@ -316,7 +316,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -374,7 +374,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -427,7 +427,7 @@ ___
{
"name": "ReservationItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a reservation of an inventory item at a stock location",
"optional": false,
"defaultValue": "",
"children": []
@@ -485,7 +485,7 @@ ___
{
"name": "ReservationItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a reservation of an inventory item at a stock location",
"optional": false,
"defaultValue": "",
"children": []
@@ -959,6 +959,48 @@ ___
___
### restoreInventoryItem
▸ **restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\>
#### Parameters
<ParameterTypes parameters={[
{
"name": "inventoryItemId",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "context",
"type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`Promise`<`void`\>
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### retrieveAvailableQuantity
▸ **retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\>
@@ -1066,7 +1108,7 @@ ___
{
"name": "InventoryItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Title of the inventory item",
"optional": false,
"defaultValue": "",
"children": []
@@ -1125,7 +1167,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1176,7 +1218,7 @@ ___
{
"name": "ReservationItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a reservation of an inventory item at a stock location",
"optional": false,
"defaultValue": "",
"children": []
@@ -1353,7 +1395,7 @@ ___
{
"name": "InventoryItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Title of the inventory item",
"optional": false,
"defaultValue": "",
"children": []
@@ -1420,7 +1462,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1478,7 +1520,7 @@ ___
{
"name": "InventoryLevelDTO",
"type": "`object`",
"description": "",
"description": "#### Schema The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"children": []
@@ -1539,7 +1581,7 @@ ___
{
"name": "ReservationItemDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a reservation of an inventory item at a stock location",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx
+4 -4
View File
@@ -71,7 +71,7 @@ ___
{
"name": "StockLocationDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a Stock Location",
"optional": false,
"defaultValue": "",
"children": []
@@ -179,7 +179,7 @@ ___
{
"name": "StockLocationDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a Stock Location",
"optional": false,
"defaultValue": "",
"children": []
@@ -307,7 +307,7 @@ ___
{
"name": "StockLocationDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a Stock Location",
"optional": false,
"defaultValue": "",
"children": []
@@ -366,7 +366,7 @@ ___
{
"name": "StockLocationDTO",
"type": "`object`",
"description": "",
"description": "#### Schema Represents a Stock Location",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx
+518
View File
@@ -0,0 +1,518 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# IncomingHttpHeaders
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IncomingHttpHeaders
## Properties
<ParameterTypes parameters={[
{
"name": "accept",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "accept-language",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "accept-patch",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "accept-ranges",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-allow-credentials",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-allow-headers",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-allow-methods",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-allow-origin",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-expose-headers",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-max-age",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-request-headers",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "access-control-request-method",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "age",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "allow",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "alt-svc",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "authorization",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "cache-control",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "connection",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-disposition",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-encoding",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-language",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-length",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-location",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-range",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "content-type",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "cookie",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "date",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "etag",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "expect",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "expires",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "forwarded",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "from",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "host",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "if-match",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "if-modified-since",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "if-none-match",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "if-unmodified-since",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "last-modified",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "location",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "origin",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "pragma",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "proxy-authenticate",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "proxy-authorization",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "public-key-pins",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "range",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "referer",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "retry-after",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sec-websocket-accept",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sec-websocket-extensions",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sec-websocket-key",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sec-websocket-protocol",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "sec-websocket-version",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "set-cookie",
"type": "`string`[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "strict-transport-security",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "tk",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "trailer",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "transfer-encoding",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "upgrade",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "user-agent",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "vary",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "via",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "warning",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "www-authenticate",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx
+30
View File
@@ -0,0 +1,30 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# IpcSocketConnectOpts
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IpcSocketConnectOpts
## Properties
<ParameterTypes parameters={[
{
"name": "onread",
"type": "[`OnReadOpts`](admin_discounts.internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "path",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx
+46
View File
@@ -0,0 +1,46 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# LookupOneOptions
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).LookupOneOptions
## Properties
<ParameterTypes parameters={[
{
"name": "all",
"type": "``false``",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "family",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "hints",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "verbatim",
"type": "`boolean`",
"description": "#### Default ```ts true ```",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOptions.mdx
+46
View File
@@ -0,0 +1,46 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# LookupOptions
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).LookupOptions
## Properties
<ParameterTypes parameters={[
{
"name": "all",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "family",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "hints",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "verbatim",
"type": "`boolean`",
"description": "#### Default ```ts true ```",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx
+68
View File
@@ -0,0 +1,68 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# OnReadOpts
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).OnReadOpts
## Properties
<ParameterTypes parameters={[
{
"name": "buffer",
"type": "`Uint8Array` \\| () => `Uint8Array`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Methods
### callback
▸ **callback**(`bytesWritten`, `buf`): `boolean`
This function is called for every chunk of incoming data.
Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer.
Return false from this function to implicitly pause() the socket.
#### Parameters
<ParameterTypes parameters={[
{
"name": "bytesWritten",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "buf",
"type": "`Uint8Array`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
#### Returns
`boolean`
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx
+54
View File
@@ -0,0 +1,54 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SocketConstructorOpts
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).SocketConstructorOpts
## Properties
<ParameterTypes parameters={[
{
"name": "allowHalfOpen",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "fd",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "readable",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "signal",
"type": "`AbortSignal`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "writable",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx
+118
View File
@@ -0,0 +1,118 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# TcpSocketConnectOpts
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).TcpSocketConnectOpts
## Properties
<ParameterTypes parameters={[
{
"name": "autoSelectFamily",
"type": "`boolean`",
"description": "#### Since v18.13.0",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "autoSelectFamilyAttemptTimeout",
"type": "`number`",
"description": "#### Since v18.13.0",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "family",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "hints",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "host",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "keepAlive",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "keepAliveInitialDelay",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "localAddress",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "localPort",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "lookup",
"type": "[`LookupFunction`](../../admin_discounts/modules/admin_discounts.internal.mdx#lookupfunction)",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "noDelay",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "onread",
"type": "[`OnReadOpts`](admin_discounts.internal.OnReadOpts.mdx)",
"description": "If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "port",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx
+3982
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
+1 -1
View File
@@ -716,7 +716,7 @@ Returns whether the stream has encountered an error.
<ParameterTypes parameters={[
{
"name": "stream",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`Writable`](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx)",
"type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \\| [`Readable`](../classes/admin_discounts.internal.Readable.mdx) \\| [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`Writable`](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx
+2 -2
View File
@@ -76,7 +76,7 @@ ___
{
"name": "size",
"type": "`number`",
"description": "The total size of the `Blob` in bytes.",
"description": "The total size of the `Blob` in bytes. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
@@ -84,7 +84,7 @@ ___
{
"name": "type",
"type": "`string`",
"description": "The content-type of the `Blob`.",
"description": "The content-type of the `Blob`. #### Since v15.7.0, v14.18.0",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx
+127
View File
@@ -344,6 +344,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [IPriceSelectionStrategy](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)
- [ITaxCalculationStrategy](../interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx)
- [ITaxService](../interfaces/admin_discounts.internal.internal.ITaxService.mdx)
- [MedusaRequest](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx)
- [PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx)
- [PaymentProcessorError](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)
- [PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx)
@@ -4771,6 +4772,132 @@ ___
___
### MedusaNextFunction
Ƭ **MedusaNextFunction**: `NextFunction`
___
### MedusaRequestHandler
Ƭ **MedusaRequestHandler**: (`req`: [`MedusaRequest`](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx), `res`: [`MedusaResponse`](admin_discounts.internal.internal.mdx#medusaresponse), `next`: [`MedusaNextFunction`](admin_discounts.internal.internal.mdx#medusanextfunction)) => `Promise`<`void`\> \| `void`
#### Type declaration
▸ (`req`, `res`, `next`): `Promise`<`void`\> \| `void`
##### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "[`MedusaRequest`](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "res",
"type": "[`MedusaResponse`](admin_discounts.internal.internal.mdx#medusaresponse)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "next",
"type": "[`MedusaNextFunction`](admin_discounts.internal.internal.mdx#medusanextfunction)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
##### Returns
`Promise`<`void`\> \| `void`
<ParameterTypes parameters={[
{
"name": "Promise<void\\> \\| void",
"type": "`Promise`<`void`\\> \\| `void`",
"optional": true,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### MedusaResponse
Ƭ **MedusaResponse**: `Response`
___
### MiddlewareFunction
Ƭ **MiddlewareFunction**: [`MedusaRequestHandler`](admin_discounts.internal.internal.mdx#medusarequesthandler) \| (...`args`: `any`[]) => `any`
___
### MiddlewareRoute
Ƭ **MiddlewareRoute**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "matcher",
"type": "`string` \\| `RegExp`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "method",
"type": "[`MiddlewareVerb`](../../admin_discounts/modules/admin_discounts.internal.mdx#middlewareverb) \\| [`MiddlewareVerb`](../../admin_discounts/modules/admin_discounts.internal.mdx#middlewareverb)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "middlewares",
"type": "[`MiddlewareFunction`](admin_discounts.internal.internal.mdx#middlewarefunction)[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
___
### MiddlewaresConfig
Ƭ **MiddlewaresConfig**: `Object`
#### Type declaration
<ParameterTypes parameters={[
{
"name": "routes",
"type": "[`MiddlewareRoute`](admin_discounts.internal.internal.mdx#middlewareroute)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
___
### PartialPick
Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] }
www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx
+3 -3
View File
@@ -60,7 +60,7 @@ Creates a line-item for a cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -121,7 +121,7 @@ Remove a line-item from a cart
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -191,7 +191,7 @@ Only quantity updates are allowed
{
"name": "StoreCartsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Cart details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx
+1 -1
View File
@@ -160,7 +160,7 @@ ___
{
"name": "StoreOrderEditsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order edit details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx
+3 -3
View File
@@ -96,7 +96,7 @@ ___
{
"name": "StoreOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -197,7 +197,7 @@ ___
{
"name": "StoreOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -252,7 +252,7 @@ ___
{
"name": "StoreOrdersRes",
"type": "`object`",
"description": "",
"description": "#### Schema Order details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx
+6 -6
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StorePaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment collection's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -117,7 +117,7 @@ ___
{
"name": "StorePaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment collection's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -176,7 +176,7 @@ ___
{
"name": "StorePaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment collection's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -235,7 +235,7 @@ ___
{
"name": "StorePaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment collection's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -294,7 +294,7 @@ ___
{
"name": "StorePaymentCollectionsSessionRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment session's details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -353,7 +353,7 @@ ___
{
"name": "StorePaymentCollectionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Payment collection's details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx
+1 -1
View File
@@ -44,7 +44,7 @@ Lists customer payment methods
{
"name": "StoreCustomersListPaymentMethodsRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of saved payment method details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreGetProductCategoriesRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)[] }",
"description": "",
"description": "#### Schema An array of product categories details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -113,7 +113,7 @@ ___
{
"name": "StoreGetProductCategoriesCategoryRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product category details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx
+1 -1
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreProductTagsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)[] }",
"description": "",
"description": "#### Schema An array of product tags details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx
+1 -1
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreProductTypesListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)[] }",
"description": "",
"description": "#### Schema An array of product types details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreVariantsListRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of product variant descriptions.",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "StoreVariantsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product variant description.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx
+3 -3
View File
@@ -63,7 +63,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreProductsListRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)[] }",
"description": "",
"description": "#### Schema An array of products details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -118,7 +118,7 @@ ___
{
"name": "StoreProductsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Product details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -173,7 +173,7 @@ ___
{
"name": "StorePostSearchRes",
"type": "{ `hits`: `unknown`[] } & Record<`string`, `unknown`\\>",
"description": "",
"description": "#### Schema Array of search results. The format of the items depends on the search engine installed on the Medusa backend.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx
+2 -2
View File
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreRegionsListRes",
"type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx)[] }",
"description": "",
"description": "#### Schema An array of regions details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -97,7 +97,7 @@ ___
{
"name": "StoreRegionsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Region details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx
+2 -2
View File
@@ -44,7 +44,7 @@ Lists return reasons defined in Medusa Admin
{
"name": "StoreReturnReasonsListRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of return reasons details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -95,7 +95,7 @@ ___
{
"name": "StoreReturnReasonsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Return reason details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx
+1 -1
View File
@@ -52,7 +52,7 @@ Creates a return request
{
"name": "StoreReturnsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Return details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreShippingOptionsListRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of shipping options details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "StoreShippingOptionsListRes",
"type": "`object`",
"description": "",
"description": "#### Schema An array of shipping options details.",
"optional": false,
"defaultValue": "",
"children": []
www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx
+2 -2
View File
@@ -50,7 +50,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"name": "StoreSwapsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Swap details.",
"optional": false,
"defaultValue": "",
"children": []
@@ -105,7 +105,7 @@ ___
{
"name": "StoreSwapsRes",
"type": "`object`",
"description": "",
"description": "#### Schema Swap details.",
"optional": false,
"defaultValue": "",
"children": []