diff --git a/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx index c029af6b27..ecdd60b489 100644 --- a/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx +++ b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx index e63198a132..37bfe8d9b3 100644 --- a/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx index b21480863f..ca778fb1ba 100644 --- a/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx index b92a1f5025..38610b02d8 100644 --- a/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx b/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx index 17fe6d7d08..f3f3c66964 100644 --- a/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx b/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx index 22d6d3b58a..0bf9161915 100644 --- a/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx index 81bf983e3a..0f738ffbe1 100644 --- a/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx index a143f47ad0..19b61a55d8 100644 --- a/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx index cdac5d7c4a..616a7f8ee1 100644 --- a/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx @@ -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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +`void` + + + +___ + ### MedusaContainer Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: (`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` diff --git a/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx index a564255165..2c2554f65f 100644 --- a/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx index b39f326121..658daf26c2 100644 --- a/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx index 6ee9231b8b..59cbe9ba20 100644 --- a/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx index b11f46c0dd..5ae4620642 100644 --- a/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx index d6db3c89ab..66a73a4379 100644 --- a/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx index 385bc0dfae..9da51d9a67 100644 --- a/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx index 07514174ad..b6454a9056 100644 --- a/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx index 577f499788..730f62de3f 100644 --- a/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx index c0e36e0274..ef0e32138d 100644 --- a/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx index 179e538f44..f9c80c7695 100644 --- a/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx index 8aef8ebbeb..16ad1eece3 100644 --- a/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx index 783a8559fe..1ccf7fd245 100644 --- a/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx index e14ab0f36e..7297b30b59 100644 --- a/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx index 323a770b85..28e558641b 100644 --- a/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx index fb8fccb904..99753c332c 100644 --- a/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx index 27156eb762..76ffd3be1b 100644 --- a/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx index 35679b6da1..d1c16bbe6c 100644 --- a/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx index feae08f6eb..7bf74b09c0 100644 --- a/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx index 9cce92943a..a6e2bf5ee1 100644 --- a/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx index 4c37b79f6c..7604f1e5a0 100644 --- a/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx index 1391f2aaea..44cdb21b60 100644 --- a/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx index 0184e22b2d..6de3f8e96c 100644 --- a/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx index 16911aa806..c2ed78d616 100644 --- a/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx index 74bea94a53..c5120dd03c 100644 --- a/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx index c28384ae79..19b979351a 100644 --- a/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx index 2179b93bc6..afa7cb5f85 100644 --- a/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx index f38c6baaf2..b0fcb7a292 100644 --- a/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx index e26f5f5b0f..e0ffdacd20 100644 --- a/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx b/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx index 24e1edd2c6..55c6d8b299 100644 --- a/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx index 5dbe482818..bb7663dd9a 100644 --- a/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx index b1965f932c..ff9a1215af 100644 --- a/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx +++ b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx index ff0a6694ba..316623d91c 100644 --- a/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx +++ b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx index 55ad447303..8b19265a26 100644 --- a/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx index 86d5c33ade..286fb2d40f 100644 --- a/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx +++ b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx index c556ea45ef..f5955786fb 100644 --- a/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx index edd55cea04..3f38179e03 100644 --- a/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx @@ -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 diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx index eba9e600c5..3eae3a34fb 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx @@ -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`", diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx index 8483752d8b..3d8aa61a50 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx index 10c7ae3e64..659011c85d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx @@ -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. \\| `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": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx index b7cdab1693..37152e333a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx @@ -28,8 +28,8 @@ v0.1.26 { // 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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx index 95c037881d..e1eb2af5ca 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx index a37624a72d..007af05900 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx index 5daa814fcb..c8d7f22571 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx @@ -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. \\| `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": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx index e246b3d3ae..096eeb8f5b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx @@ -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. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx index 3434b573f1..18acd656c7 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx @@ -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. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx new file mode 100644 index 0000000000..90a9d464f7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx @@ -0,0 +1,6598 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Socket + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Socket + +This class is an abstraction of a TCP socket or a streaming `IPC` endpoint +(uses named pipes on Windows, and Unix domain sockets otherwise). It is also +an `EventEmitter`. + +A `net.Socket` can be created by the user and used directly to interact with +a server. For example, it is returned by createConnection, +so the user can use it to talk to the server. + +It can also be created by Node.js and passed to the user when a connection +is received. For example, it is passed to the listeners of a `'connection'` event emitted on a Server, so the user can use +it to interact with the client. + +#### Since + +v0.3.4 + +## Properties + + { // 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.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": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[[asyncIterator]](admin_discounts.internal.Duplex.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_construct](admin_discounts.internal.Duplex.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_destroy](admin_discounts.internal.Duplex.mdx#_destroy) + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_final](admin_discounts.internal.Duplex.mdx#_final) + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_read](admin_discounts.internal.Duplex.mdx#_read) + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_write](admin_discounts.internal.Duplex.mdx#_write) + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_writev](admin_discounts.internal.Duplex.mdx#_writev) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +events.EventEmitter + 1. close + 2. connect + 3. data + 4. drain + 5. end + 6. error + 7. lookup + 8. ready + 9. timeout + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +___ + +### address + +▸ **address**(): {} \| [`AddressInfo`](../interfaces/admin_discounts.internal.AddressInfo.mdx) + +Returns the bound `address`, the address `family` name and `port` of the +socket as reported by the operating system:`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` + +#### Returns + +{} \| [`AddressInfo`](../interfaces/admin_discounts.internal.AddressInfo.mdx) + + + +#### Since + +v0.1.90 + +___ + +### connect + +▸ **connect**(`options`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Initiate a connection on a given socket. + +Possible signatures: + +* `socket.connect(options[, connectListener])` +* `socket.connect(path[, connectListener])` for `IPC` connections. +* `socket.connect(port[, host][, connectListener])` for TCP connections. +* Returns: `net.Socket` The socket itself. + +This function is asynchronous. When the connection is established, the `'connect'` event will be emitted. If there is a problem connecting, +instead of a `'connect'` event, an `'error'` event will be emitted with +the error passed to the `'error'` listener. +The last parameter `connectListener`, if supplied, will be added as a listener +for the `'connect'` event **once**. + +This function should only be used for reconnecting a socket after`'close'` has been emitted or otherwise it may lead to undefined +behavior. + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +▸ **connect**(`port`, `host`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +▸ **connect**(`port`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +▸ **connect**(`path`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +___ + +### cork + +▸ **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.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 +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + + + +#### Since + +v0.11.2 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[cork](admin_discounts.internal.Duplex.mdx#cork) + +___ + +### destroy + +▸ **destroy**(`error?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v8.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[destroy](admin_discounts.internal.Duplex.mdx#destroy) + +___ + +### emit + +▸ **emit**(`event`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `hadError`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `data`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `err`, `address`, `family`, `host`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +___ + +### end + +▸ **end**(`callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Half-closes the socket. i.e., it sends a FIN packet. It is possible the +server will still send some data. + +See `writable.end()` for further details. + +#### Parameters + + `void`", + "description": "Optional callback for when the socket is finished.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.90 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +▸ **end**(`buffer`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +▸ **end**(`str`, `encoding?`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + + + +#### Since + +v6.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[eventNames](admin_discounts.internal.Duplex.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Socket.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[getMaxListeners](admin_discounts.internal.Duplex.mdx#getmaxlisteners) + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + + + +#### Since + +v0.11.14 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[isPaused](admin_discounts.internal.Duplex.mdx#ispaused) + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listenerCount](admin_discounts.internal.Duplex.mdx#listenercount) + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listeners](admin_discounts.internal.Duplex.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[off](admin_discounts.internal.Duplex.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.101 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +___ + +### once + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.3.0 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +___ + +### pause + +▸ **pause**(): [`Socket`](admin_discounts.internal.Socket.mdx) + +Pauses the reading of data. That is, `'data'` events will not be emitted. +Useful to throttle back an upload. + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[pause](admin_discounts.internal.Duplex.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[pipe](admin_discounts.internal.Duplex.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v6.0.0 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v6.0.0 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[push](admin_discounts.internal.Duplex.mdx#push) + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[rawListeners](admin_discounts.internal.Duplex.mdx#rawlisteners) + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +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](../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 + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[read](admin_discounts.internal.Duplex.mdx#read) + +___ + +### ref + +▸ **ref**(): [`Socket`](admin_discounts.internal.Socket.mdx) + +Opposite of `unref()`, calling `ref()` on a previously `unref`ed socket will _not_ let the program exit if it's the only socket left (the default behavior). +If the socket is `ref`ed calling `ref` again will have no effect. + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.9.1 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeAllListeners](admin_discounts.internal.Duplex.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +___ + +### resetAndDestroy + +▸ **resetAndDestroy**(): [`Socket`](admin_discounts.internal.Socket.mdx) + +Close the TCP connection by sending an RST packet and destroy the stream. +If this TCP socket is in connecting status, it will send an RST packet and destroy this TCP socket once it is connected. +Otherwise, it will call `socket.destroy` with an `ERR_SOCKET_CLOSED` Error. +If this is not a TCP socket (for example, a pipe), calling this method will immediately throw an `ERR_INVALID_HANDLE_TYPE` Error. + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v18.3.0, v16.17.0 + +___ + +### resume + +▸ **resume**(): [`Socket`](admin_discounts.internal.Socket.mdx) + +Resumes reading after a call to `socket.pause()`. + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[resume](admin_discounts.internal.Duplex.mdx#resume) + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Socket`](admin_discounts.internal.Socket.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.11.15 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setDefaultEncoding](admin_discounts.internal.Duplex.mdx#setdefaultencoding) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Set the encoding for the socket as a `Readable Stream`. See `readable.setEncoding()` for more information. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.90 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[setEncoding](admin_discounts.internal.Duplex.mdx#setencoding) + +___ + +### setKeepAlive + +▸ **setKeepAlive**(`enable?`, `initialDelay?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Enable/disable keep-alive functionality, and optionally set the initial +delay before the first keepalive probe is sent on an idle socket. + +Set `initialDelay` (in milliseconds) to set the delay between the last +data packet received and the first keepalive probe. Setting `0` for`initialDelay` will leave the value unchanged from the default +(or previous) setting. + +Enabling the keep-alive functionality will set the following socket options: + +* `SO_KEEPALIVE=1` +* `TCP_KEEPIDLE=initialDelay` +* `TCP_KEEPCNT=10` +* `TCP_KEEPINTVL=1` + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.92 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Socket`](admin_discounts.internal.Socket.mdx) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setMaxListeners](admin_discounts.internal.Duplex.mdx#setmaxlisteners) + +___ + +### setNoDelay + +▸ **setNoDelay**(`noDelay?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Enable/disable the use of Nagle's algorithm. + +When a TCP connection is created, it will have Nagle's algorithm enabled. + +Nagle's algorithm delays data before it is sent via the network. It attempts +to optimize throughput at the expense of latency. + +Passing `true` for `noDelay` or not passing an argument will disable Nagle's +algorithm for the socket. Passing `false` for `noDelay` will enable Nagle's +algorithm. + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.90 + +___ + +### setTimeout + +▸ **setTimeout**(`timeout`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +Sets the socket to timeout after `timeout` milliseconds of inactivity on +the socket. By default `net.Socket` do not have a timeout. + +When an idle timeout is triggered the socket will receive a `'timeout'` event but the connection will not be severed. The user must manually call `socket.end()` or `socket.destroy()` to +end the connection. + +```js +socket.setTimeout(3000); +socket.on('timeout', () => { + console.log('socket timeout'); + socket.end(); +}); +``` + +If `timeout` is 0, then the existing idle timeout is disabled. + +The optional `callback` parameter will be added as a one-time listener for the `'timeout'` event. + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.1.90 + +___ + +### uncork + +▸ **uncork**(): `void` + +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 +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + + + +#### Since + +v0.11.2 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[uncork](admin_discounts.internal.Duplex.mdx#uncork) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Socket`](admin_discounts.internal.Socket.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[unpipe](admin_discounts.internal.Duplex.mdx#unpipe) + +___ + +### unref + +▸ **unref**(): [`Socket`](admin_discounts.internal.Socket.mdx) + +Calling `unref()` on a socket will allow the program to exit if this is the only +active socket in the event system. If the socket is already `unref`ed calling`unref()` again will have no effect. + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.9.1 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +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](../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. + +#### Parameters + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[unshift](admin_discounts.internal.Duplex.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`Socket`](admin_discounts.internal.Socket.mdx) + +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](../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. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + + + +#### Returns + +[`Socket`](admin_discounts.internal.Socket.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[wrap](admin_discounts.internal.Duplex.mdx#wrap) + +___ + +### write + +▸ **write**(`buffer`, `cb?`): `boolean` + +Sends data on the socket. The second parameter specifies the encoding in the +case of a string. It defaults to UTF8 encoding. + +Returns `true` if the entire data was flushed successfully to the kernel +buffer. Returns `false` if all or part of the data was queued in user memory.`'drain'` will be emitted when the buffer is again free. + +The optional `callback` parameter will be executed when the data is finally +written out, which may not be immediately. + +See `Writable` stream `write()` method for more +information. + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.1.90 + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[write](admin_discounts.internal.Duplex.mdx#write) + +▸ **write**(`str`, `encoding?`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Overrides + +[Duplex](admin_discounts.internal.Duplex.mdx).[write](admin_discounts.internal.Duplex.mdx#write) + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +A utility method for creating duplex streams. + +- `Stream` converts writable stream into writable `Duplex` and readable stream + to `Duplex`. +- `Blob` converts into readable `Duplex`. +- `string` converts into readable `Duplex`. +- `ArrayBuffer` converts into readable `Duplex`. +- `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`. +- `AsyncGeneratorFunction` converts into a readable/writable transform + `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield + `null`. +- `AsyncFunction` converts into a writable `Duplex`. Must return + either `null` or `undefined` +- `Object ({ writable, readable })` converts `readable` and + `writable` into `Stream` and then combines them into `Duplex` where the + `Duplex` will write to the `writable` and read from the `readable`. +- `Promise` converts into readable `Duplex`. Value `null` is ignored. + +#### Parameters + + \\| [`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": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[from](admin_discounts.internal.Duplex.mdx#from) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "duplexStream.writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`DuplexOptions`](../interfaces/admin_discounts.internal.DuplexOptions.mdx), ``\"signal\"`` \\| ``\"allowHalfOpen\"`` \\| ``\"decodeStrings\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v17.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[fromWeb](admin_discounts.internal.Duplex.mdx#fromweb) + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[getEventListeners](admin_discounts.internal.Duplex.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[isDisturbed](admin_discounts.internal.Duplex.mdx#isdisturbed) + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listenerCount](admin_discounts.internal.Duplex.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on-1) + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setMaxListeners](admin_discounts.internal.Duplex.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + + + +#### Returns + +`object` + + + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Since + +v17.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[toWeb](admin_discounts.internal.Duplex.mdx#toweb) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx index b6af788eb9..056874142e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx @@ -28,8 +28,8 @@ v0.1.26 { // 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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx index 5d59bb2518..ed17274f0b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx @@ -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. \\| `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": "", diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx index 7c35c72cb5..9241f35ebb 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx @@ -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 diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx index e4b5ea625c..5f67d34c5f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx @@ -28,8 +28,8 @@ v0.1.26 { // 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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx index 7e6b4855d2..baf255c186 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx @@ -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": [] }, diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx index bf95a371a0..7b21dfbf1e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx index 992b648230..94032bbb9d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx index d2bbc11314..f110fe7988 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AddressInfo.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AddressInfo.mdx new file mode 100644 index 0000000000..6aaf5faa46 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AddressInfo.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx index 68db6c308c..2f9d6809a1 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx index 5b5b21fd6b..561dbac80a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ConnectOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ConnectOpts.mdx new file mode 100644 index 0000000000..daf3407ec2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ConnectOpts.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Dict.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Dict.mdx new file mode 100644 index 0000000000..b49fc770f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Dict.mdx @@ -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 + + + +## Indexable + +▪ [key: `string`]: `T` \| `undefined` diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx index 08c625fbf1..255325ebfe 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx @@ -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 + + + +#### Returns + +`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": [] diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx index 9d84d81d77..341e0bfa68 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx new file mode 100644 index 0000000000..692afb19d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx new file mode 100644 index 0000000000..cdcdc88f2e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx new file mode 100644 index 0000000000..866cc70f44 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOptions.mdx new file mode 100644 index 0000000000..3c6aa4699f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.LookupOptions.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx new file mode 100644 index 0000000000..7941e05588 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx @@ -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 + + `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 + + + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx new file mode 100644 index 0000000000..bf4afeb6ec --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx new file mode 100644 index 0000000000..2551033311 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx @@ -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 + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx new file mode 100644 index 0000000000..38203c7c97 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx @@ -0,0 +1,3982 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MedusaRequest + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).MedusaRequest + +## Properties + +stream.Readable.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allowedProperties", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "closed", + "type": "`boolean`", + "description": "Is `true` after `'close'` has been emitted. #### Since v18.0.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "complete", + "type": "`boolean`", + "description": "The `message.complete` property will be `true` if a complete HTTP message has been received and successfully parsed. This property is particularly useful as a means of determining if a client or server fully transmitted a message before a connection was terminated: ```js const req = http.request({ host: '127.0.0.1', port: 8080, method: 'POST', }, (res) => { res.resume(); res.on('end', () => { if (!res.complete) console.error( 'The connection was terminated while the message was still being sent'); }); }); ``` #### Since v0.3.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "connection", + "type": "[`Socket`](../classes/admin_discounts.internal.Socket.mdx)", + "description": "Alias for `message.socket`. #### Since v0.1.90 #### Deprecated Since v16.0.0 - Use `socket`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "destroyed", + "type": "`boolean`", + "description": "Is `true` after `readable.destroy()` has been called. #### Since v8.0.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "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. #### Since v18.0.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errors", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "filterableFields", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "headers", + "type": "[`IncomingHttpHeaders`](admin_discounts.internal.IncomingHttpHeaders.mdx)", + "description": "The request/response headers object. Key-value pairs of header names and values. Header names are lower-cased. ```js // Prints something like: // // { 'user-agent': 'curl/7.22.0', // host: '127.0.0.1:8000', // accept: '*' } console.log(request.headers); ``` Duplicates in raw headers are handled in the following ways, depending on the header name: * Duplicates of `age`, `authorization`, `content-length`, `content-type`,`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,`retry-after`, `server`, or `user-agent` are discarded. To allow duplicate values of the headers listed above to be joined, use the option `joinDuplicateHeaders` in request and createServer. See RFC 9110 Section 5.3 for more information. * `set-cookie` is always an array. Duplicates are added to the array. * For duplicate `cookie` headers, the values are joined together with `; `. * For all other headers, the values are joined together with `, `. #### Since v0.1.5", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "headersDistinct", + "type": "[`Dict`](admin_discounts.internal.Dict.mdx)<`string`[]\\>", + "description": "Similar to `message.headers`, but there is no join logic and the values are always arrays of strings, even for headers received just once. ```js // Prints something like: // // { 'user-agent': ['curl/7.22.0'], // host: ['127.0.0.1:8000'], // accept: ['*'] } console.log(request.headersDistinct); ``` #### Since v18.3.0, v16.17.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "httpVersion", + "type": "`string`", + "description": "In case of server request, the HTTP version sent by the client. In the case of client response, the HTTP version of the connected-to server. Probably either `'1.1'` or `'1.0'`. Also `message.httpVersionMajor` is the first integer and`message.httpVersionMinor` is the second. #### Since v0.1.1", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "httpVersionMajor", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "httpVersionMinor", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes", + "type": "Record<`string`, `boolean`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "listConfig", + "type": "[`FindConfig`](admin_discounts.internal.internal.FindConfig.mdx)<`unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rawHeaders", + "type": "`string`[]", + "description": "The raw request/response headers list exactly as they were received. The keys and values are in the same list. It is _not_ a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values. Header names are not lowercased, and duplicates are not merged. ```js // Prints something like: // // [ 'user-agent', // 'this is invalid because there can be only one', // 'User-Agent', // 'curl/7.22.0', // 'Host', // '127.0.0.1:8000', // 'ACCEPT', // '*' ] console.log(request.rawHeaders); ``` #### Since v0.11.6", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rawTrailers", + "type": "`string`[]", + "description": "The raw request/response trailer keys and values exactly as they were received. Only populated at the `'end'` event. #### Since v0.11.6", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "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'`. #### Since v11.4.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "readableAborted", + "type": "`boolean`", + "description": "Returns whether the stream was destroyed or errored before emitting `'end'`. #### Since v16.8.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "readableDidRead", + "type": "`boolean`", + "description": "Returns whether `'data'` has been emitted. #### Since v16.7.0, v14.18.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "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. #### Since v12.7.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "readableEnded", + "type": "`boolean`", + "description": "Becomes `true` when `'end'` event is emitted. #### Since v12.9.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "readableFlowing", + "type": "``null`` \\| `boolean`", + "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": [] + }, + { + "name": "readableHighWaterMark", + "type": "`number`", + "description": "Returns the value of `highWaterMark` passed when creating this `Readable`. #### Since v9.3.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "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`. #### Since v9.4.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "readableObjectMode", + "type": "`boolean`", + "description": "Getter for the property `objectMode` of a given `Readable` stream. #### Since v12.3.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "retrieveConfig", + "type": "[`FindConfig`](admin_discounts.internal.internal.FindConfig.mdx)<`unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "scope", + "type": "[`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer-1)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "socket", + "type": "[`Socket`](../classes/admin_discounts.internal.Socket.mdx)", + "description": "The `net.Socket` object associated with the connection. With HTTPS support, use `request.socket.getPeerCertificate()` to obtain the client's authentication details. This property is guaranteed to be an instance of the `net.Socket` class, a subclass of `stream.Duplex`, unless the user specified a socket type other than `net.Socket` or internally nulled. #### Since v0.3.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "statusCode", + "type": "`number`", + "description": "**Only valid for response obtained from ClientRequest.** The 3-digit HTTP response status code. E.G. `404`. #### Since v0.1.1", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "statusMessage", + "type": "`string`", + "description": "**Only valid for response obtained from ClientRequest.** The HTTP response status message (reason phrase). E.G. `OK` or `Internal Server Error`. #### Since v0.11.10", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "trailers", + "type": "[`Dict`](admin_discounts.internal.Dict.mdx)<`string`\\>", + "description": "The request/response trailers object. Only populated at the `'end'` event. #### Since v0.3.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "trailersDistinct", + "type": "[`Dict`](admin_discounts.internal.Dict.mdx)<`string`[]\\>", + "description": "Similar to `message.trailers`, but there is no join logic and the values are always arrays of strings, even for headers received just once. Only populated at the `'end'` event. #### Since v18.3.0, v16.17.0", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "user", + "type": "`Object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "validatedBody", + "type": "`unknown`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "validatedQuery", + "type": "[`RequestQueryFields`](../modules/admin_discounts.internal.internal.mdx#requestqueryfields) & Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Request.[asyncIterator] + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +Request.\_construct + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +Request.\_destroy + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +Request.\_read + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +Event emitter +The defined events on documents including: +1. close +2. data +3. end +4. error +5. pause +6. readable +7. resume + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.addListener + +___ + +### destroy + +▸ **destroy**(`error?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed +as an argument to any listeners on the event. + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +Request.destroy + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.emit + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + + + +#### Since + +v6.0.0 + +#### Inherited from + +Request.eventNames + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +Request.getMaxListeners + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + + + +#### Since + +v0.11.14 + +#### Inherited from + +Request.isPaused + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +Request.listenerCount + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +Request.listeners + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +Request.off + +___ + +### on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.on + +___ + +### once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.once + +___ + +### pause + +▸ **pause**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.pause + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +Request.pipe + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +▸ **prependListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependListener + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.prependOnceListener + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +Request.push + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +Request.rawListeners + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +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.internal.MedusaRequest.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.read + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +Request.removeAllListeners + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +▸ **removeListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Inherited from + +Request.removeListener + +___ + +### resume + +▸ **resume**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.resume + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.setEncoding + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +Request.setMaxListeners + +___ + +### setTimeout + +▸ **setTimeout**(`msecs`, `callback?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +Calls `message.socket.setTimeout(msecs, callback)`. + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.5.9 + +#### Inherited from + +Request.setTimeout + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.unpipe + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](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.internal.MedusaRequest.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](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. + +#### Parameters + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +Request.unshift + +___ + +### wrap + +▸ **wrap**(`stream`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + +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.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. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + + + +#### Returns + +[`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +Request.wrap diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx index d51faf5a2c..43b6e6efbb 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx @@ -716,7 +716,7 @@ Returns whether the stream has encountered an error. `Promise`<`void`\> \| `void` + +#### Type declaration + +▸ (`req`, `res`, `next`): `Promise`<`void`\> \| `void` + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> \| `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 + + + +___ + +### MiddlewaresConfig + +Ƭ **MiddlewaresConfig**: `Object` + +#### Type declaration + + + +___ + ### PartialPick Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } diff --git a/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx index 8e671e0c04..fc8ce6d479 100644 --- a/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx index fca3e9bde2..6a21337a11 100644 --- a/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx @@ -160,7 +160,7 @@ ___ { "name": "StoreOrderEditsRes", "type": "`object`", - "description": "", + "description": "#### Schema Order edit details.", "optional": false, "defaultValue": "", "children": [] diff --git a/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx index 80431bb498..1d8fc50e51 100644 --- a/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx index 8f4a06be6e..cf411df13d 100644 --- a/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx index cc47b3b57b..d4afe8cea7 100644 --- a/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx +++ b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx index 32dd65a960..bfa8779ce2 100644 --- a/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx index b1a0f02563..ca180efa01 100644 --- a/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx index 57a2c4e2e5..31d338f635 100644 --- a/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx index e82a4a019b..196b8db234 100644 --- a/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx index 0188019a01..6a30b83957 100644 --- a/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx index 16f629d074..eb787ae0f6 100644 --- a/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx index 39702299b1..03991af42c 100644 --- a/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx index 4a59ed41ff..191c8a1723 100644 --- a/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx @@ -52,7 +52,7 @@ Creates a return request { "name": "StoreReturnsRes", "type": "`object`", - "description": "", + "description": "#### Schema Return details.", "optional": false, "defaultValue": "", "children": [] diff --git a/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx index bc6b485998..a722ec342a 100644 --- a/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx @@ -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": [] diff --git a/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx index e359c885e9..f393ef1fda 100644 --- a/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx @@ -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": []