chore: small fixes to tsdocs (#6341)
Small fixes of the TSDocs for the upcoming release
This commit is contained in:
1 parent
d37ff8024d
commit
1593e0b192
4 files changed
+7
-5
No files matched your search
@@ -156,7 +156,7 @@ export interface AdminGetOrdersParams {
|
||||
*/
|
||||
fields?: string
|
||||
/**
|
||||
* A order field to sort-order the retrieved orders by.
|
||||
* Field to sort retrieved orders by.
|
||||
*/
|
||||
order?: string
|
||||
}
|
||||
@@ -100,7 +100,8 @@ export interface MedusaProviderProps {
|
||||
*/
|
||||
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
|
||||
}
|
||||
|
||||
@@ -152,7 +152,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - (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) 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:
|
||||
* method: list
|
||||
* queryParams: AdminGetOrdersParams
|
||||
@@ -280,7 +280,8 @@ export class AdminGetOrdersParams extends AdminListOrdersSelector {
|
||||
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()
|
||||
@IsString()
|
||||
|
||||
@@ -469,7 +469,7 @@ export type ProjectConfigOptions = {
|
||||
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
|
||||
* ```js title="medusa-config.js"
|
||||
|
||||
Reference in new issue
Block a user