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:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
@@ -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&#60;(`null` \\| [LineItem](LineItem.mdx))[]&#62;",
"type": "Promise&#60;(null \\| [LineItem](LineItem.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the line items generated by the transformer.",
@@ -557,7 +557,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"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.",