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
www/apps/docs/content/references/services/classes/ShippingProfileService.mdx
+10 -10
View File
@@ -89,7 +89,7 @@ Provides layer to manipulate profiles.
},
{
"name": "productRepository_",
"type": "Repository<[Product](Product.mdx)> & `{ _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }`",
"type": "Repository<[Product](Product.mdx)> & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -116,7 +116,7 @@ Provides layer to manipulate profiles.
},
{
"name": "shippingProfileRepository_",
"type": "Repository<[ShippingProfile](ShippingProfile.mdx)> & `{ findByProducts: Method findByProducts }`",
"type": "Repository<[ShippingProfile](ShippingProfile.mdx)> & ``{ findByProducts: Method findByProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ Removes a product or an array of products from the profile.
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
@@ -761,16 +761,16 @@ ___
### retrieveDefault
`**retrieveDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
`**retrieveDefault**(): Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;`
#### Returns
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"type": "Promise&#60;null \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -819,18 +819,18 @@ ___
### retrieveGiftCardDefault
`**retrieveGiftCardDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
`**retrieveGiftCardDefault**(): Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;`
Retrieves the default gift card profile
#### Returns
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"type": "Promise&#60;null \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile for gift cards",
@@ -850,7 +850,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",