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

docs: general fixes to references (#5653)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

16
www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx
View File

@@ -119,7 +119,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -146,7 +146,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "Price including taxes",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "An array of applied tax rates",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -555,7 +555,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "Price including taxes",
"optional": false,
"defaultValue": "",
@@ -573,7 +573,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "An array of applied tax rates",
"optional": false,
"defaultValue": "",