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

chore: small fixes to tsdocs (#6341)

Browse Source 
Small fixes of the TSDocs for the upcoming release
This commit is contained in:
Shahed Nasser
2024-02-12 16:26:27 +00:00
committed by GitHub
parent d37ff8024d
commit 1593e0b192
4 changed files with 122 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts
+1 -1
View File
@@ -156,7 +156,7 @@ export interface AdminGetOrdersParams {
*/ */
fields?: string fields?: string
/** /**
* A order field to sort-order the retrieved orders by. * Field to sort retrieved orders by.
*/ */
order?: string order?: string
} }
packages/medusa-react/src/contexts/medusa.tsx
+2 -1
View File
@@ -100,7 +100,8 @@ export interface MedusaProviderProps {
*/ */
customHeaders?: Record<string, any> customHeaders?: Record<string, any>
/** /**
* An instance of the Medusa JS Client. If you don't provide an instance, one will be created using the `baseUrl`, `apiKey`, `publishableApiKey`, `maxRetries`, and `customHeaders` props. * An instance of the Medusa JS Client. If you don't provide an instance, one will be created using the `baseUrl`, `apiKey`,
* `publishableApiKey`, `maxRetries`, and `customHeaders` props.
*/ */
medusaClient: Medusa medusaClient: Medusa
} }
packages/medusa/src/api/routes/admin/orders/list-orders.ts
+3 -2
View File
@@ -152,7 +152,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
* - (query) limit=50 {integer} Limit the number of orders returned. * - (query) limit=50 {integer} Limit the number of orders returned.
* - (query) expand {string} Comma-separated relations that should be expanded in the returned order. * - (query) expand {string} Comma-separated relations that should be expanded in the returned order.
* - (query) fields {string} Comma-separated fields that should be included in the returned order. * - (query) fields {string} Comma-separated fields that should be included in the returned order.
* - (query) order {string} A order field to sort-order the retrieved orders by. * - (query) order {string} Field to sort retrieved orders by.
* x-codegen: * x-codegen:
* method: list * method: list
* queryParams: AdminGetOrdersParams * queryParams: AdminGetOrdersParams
@@ -280,7 +280,8 @@ export class AdminGetOrdersParams extends AdminListOrdersSelector {
fields?: string fields?: string
/** /**
* The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * The field to sort retrieved orders by. By default, the sort order is ascending.
* To change the order to descending, prefix the field name with `-`.
*/ */
@IsOptional() @IsOptional()
@IsString() @IsString()
packages/types/src/common/config-module.ts
+1 -1
View File
@@ -469,7 +469,7 @@ export type ProjectConfigOptions = {
http_compression?: HttpCompressionOptions http_compression?: HttpCompressionOptions
/** /**
* Configure the number of staged jobs that are polled from the database. Default is 1000. * Configure the number of staged jobs that are polled from the database. Default is `1000`.
* *
* @example * @example
* ```js title="medusa-config.js" * ```js title="medusa-config.js"