docs: general fixes to references (#5653)
* fixed typedoc plugin's escape strategy * move props comments to the associated property * regenerate references
This commit is contained in:
@@ -78,7 +78,7 @@ Handles Fulfillments
|
||||
},
|
||||
{
|
||||
"name": "lineItemRepository_",
|
||||
"type": "Repository<[LineItem](LineItem.mdx)> & `{ findByReturn: Method findByReturn }`",
|
||||
"type": "Repository<[LineItem](LineItem.mdx)> & ``{ findByReturn: Method findByReturn }``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -373,7 +373,7 @@ tracking links and potentially more metadata.
|
||||
},
|
||||
{
|
||||
"name": "trackingLinks",
|
||||
"type": "`{ tracking_number: string }`[]",
|
||||
"type": "``{ tracking_number: string }``[]",
|
||||
"description": "tracking links for the shipment",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -411,7 +411,7 @@ ___
|
||||
|
||||
### getFulfillmentItems\_
|
||||
|
||||
`**getFulfillmentItems_**(order, items): Promise<(`null` \| [LineItem](LineItem.mdx))[]>`
|
||||
`**getFulfillmentItems_**(order, items): Promise<(null \| [LineItem](LineItem.mdx))[]>`
|
||||
|
||||
Retrieves the order line items, given an array of items.
|
||||
|
||||
@@ -440,12 +440,12 @@ Retrieves the order line items, given an array of items.
|
||||
|
||||
#### Returns
|
||||
|
||||
Promise<(`null` \| [LineItem](LineItem.mdx))[]>
|
||||
Promise<(null \| [LineItem](LineItem.mdx))[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "Promise<(`null` \\| [LineItem](LineItem.mdx))[]>",
|
||||
"type": "Promise<(null \\| [LineItem](LineItem.mdx))[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the line items generated by the transformer.",
|
||||
@@ -557,7 +557,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "err",
|
||||
"type": "`Record<string, unknown>` \\| `{ code: string }`",
|
||||
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -586,7 +586,7 @@ ___
|
||||
|
||||
### validateFulfillmentLineItem\_
|
||||
|
||||
`**validateFulfillmentLineItem_**(item, quantity): `null` \| [LineItem](LineItem.mdx)`
|
||||
`**validateFulfillmentLineItem_**(item, quantity): null \| [LineItem](LineItem.mdx)`
|
||||
|
||||
Checks that a given quantity of a line item can be fulfilled. Fails if the
|
||||
fulfillable quantity is lower than the requested fulfillment quantity.
|
||||
@@ -618,12 +618,12 @@ quantity from the quantity that was originally purchased.
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| [LineItem](LineItem.mdx)
|
||||
`null` \| [LineItem](LineItem.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "`null` \\| LineItem",
|
||||
"type": "``null`` \\| [LineItem](LineItem.mdx)",
|
||||
"name": "null \\| LineItem",
|
||||
"type": "`null` \\| [LineItem](LineItem.mdx)",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "a line item that has the requested fulfillment quantity\n set.",
|
||||
|
||||
Reference in New Issue
Block a user