chore(docs): Generated References (automated) (#9169)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and 
GitHub committed
1 parent
26700821a2
commit
a63f6910d0
23 files changed
+31509
-31051
No files matched your search
@@ -265,7 +265,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemValidationStep/page.mdx": "2024-08-20T00:10:59.065Z",
|
||||
"references/core_flows/Order/functions/core_flows.Order.updateOrderEditAddItemWorkflow/page.mdx": "2024-08-20T00:10:59.105Z",
|
||||
"references/core_flows/core_flows.Order/page.mdx": "2024-08-20T00:10:56.437Z",
|
||||
"references/modules/core_flows/page.mdx": "2024-09-17T00:11:05.023Z",
|
||||
"references/modules/core_flows/page.mdx": "2024-09-18T00:11:14.035Z",
|
||||
"references/types/types.HttpTypes/page.mdx": "2024-09-05T00:11:17.026Z",
|
||||
"app/troubleshooting/medusa-admin/no-widget-route/page.mdx": "2024-08-23T11:31:26.346Z",
|
||||
"references/auth/IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx": "2024-09-17T00:10:59.695Z",
|
||||
@@ -476,7 +476,7 @@ export const generatedEditDates = {
|
||||
"references/modules/auth/page.mdx": "2024-08-28T00:11:06.310Z",
|
||||
"references/modules/modules_sdk/page.mdx": "2024-09-17T00:11:24.783Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteLink/page.mdx": "2024-09-17T00:11:24.823Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx": "2024-09-17T00:11:24.839Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx": "2024-09-18T00:11:33.763Z",
|
||||
"references/modules_sdk/types/modules_sdk.LinkModuleBootstrapOptions/page.mdx": "2024-09-17T00:11:24.803Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx": "2024-09-17T00:11:24.799Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx": "2024-09-17T00:11:24.795Z",
|
||||
@@ -1017,7 +1017,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-09-17T00:11:05.131Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2024-09-17T00:11:22.999Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx": "2024-09-17T00:11:23.007Z",
|
||||
"references/modules/medusa/page.mdx": "2024-09-17T00:10:57.711Z",
|
||||
"references/modules/medusa/page.mdx": "2024-09-18T00:11:06.819Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.addOrderAction/page.mdx": "2024-09-17T00:11:26.215Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2024-09-17T00:11:26.199Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2024-09-17T00:11:26.207Z",
|
||||
@@ -1155,10 +1155,10 @@ export const generatedEditDates = {
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx": "2024-09-17T00:11:06.311Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx": "2024-09-17T00:11:06.327Z",
|
||||
"references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx": "2024-09-17T00:11:06.339Z",
|
||||
"references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx": "2024-09-17T00:11:07.223Z",
|
||||
"references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx": "2024-09-18T00:11:16.271Z",
|
||||
"references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.deleteInventoryLevelsWorkflow/page.mdx": "2024-09-17T00:11:07.239Z",
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Steps_Inventory/page.mdx": "2024-09-17T00:11:07.175Z",
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx": "2024-09-17T00:11:07.219Z",
|
||||
"references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx": "2024-09-18T00:11:16.271Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.createOrderLineItemsStep/page.mdx": "2024-09-17T00:11:07.815Z",
|
||||
"references/core_flows/Order/Steps_Order/functions/core_flows.Order.Steps_Order.updateReturnsStep/page.mdx": "2024-09-17T00:11:08.027Z",
|
||||
"references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.addOrderLineItemsWorkflow/page.mdx": "2024-09-17T00:11:11.247Z",
|
||||
@@ -1199,7 +1199,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/core_flows.Steps_Inventory/page.mdx": "2024-09-17T00:11:07.263Z",
|
||||
"references/core_flows/core_flows.Steps_Tax/page.mdx": "2024-09-17T00:11:22.735Z",
|
||||
"references/core_flows/core_flows.Workflows_Api_Key/page.mdx": "2024-09-17T00:11:05.119Z",
|
||||
"references/core_flows/core_flows.Workflows_Inventory/page.mdx": "2024-09-17T00:11:07.283Z",
|
||||
"references/core_flows/core_flows.Workflows_Inventory/page.mdx": "2024-09-18T00:11:16.335Z",
|
||||
"references/core_flows/core_flows.Workflows_Tax/page.mdx": "2024-09-17T00:11:22.755Z",
|
||||
"references/core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx": "2024-09-17T00:11:23.183Z",
|
||||
"references/core_flows/types/core_flows.RevokeApiKeysStepInput/page.mdx": "2024-09-17T00:11:22.819Z",
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ This workflow creates and deletes inventory levels.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+1
-1
@@ -8,7 +8,7 @@ This workflow creates and deletes inventory levels.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ This workflow creates and deletes inventory levels.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
|
||||
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
|
||||
@@ -5289,7 +5289,7 @@ This workflow creates and deletes inventory levels.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
|
||||
@@ -52,6 +52,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
- [instrumentHttpLayer](page.mdx#instrumenthttplayer)
|
||||
- [instrumentRemoteQuery](page.mdx#instrumentremotequery)
|
||||
- [instrumentWorkflows](page.mdx#instrumentworkflows)
|
||||
- [registerOtel](page.mdx#registerotel)
|
||||
|
||||
___
|
||||
@@ -70,20 +71,28 @@ ___
|
||||
|
||||
### instrumentHttpLayer
|
||||
|
||||
Instrumenting the first touch point of the HTTP layer to report traces to
|
||||
Instrument the first touch point of the HTTP layer to report traces to
|
||||
OpenTelemetry
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrumenting the first touch point of the HTTP layer to report traces to\nOpenTelemetry","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentHttpLayer"/>
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the first touch point of the HTTP layer to report traces to\nOpenTelemetry","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentHttpLayer"/>
|
||||
|
||||
### instrumentRemoteQuery
|
||||
|
||||
Instrumenting the queries made using the remote query
|
||||
Instrument the queries made using the remote query
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrumenting the queries made using the remote query","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentRemoteQuery"/>
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the queries made using the remote query","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentRemoteQuery"/>
|
||||
|
||||
### instrumentWorkflows
|
||||
|
||||
Instrument the workflows and steps execution
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the workflows and steps execution","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentWorkflows"/>
|
||||
|
||||
### registerOtel
|
||||
|
||||
@@ -101,8 +110,8 @@ telemetry to work
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exporter","type":"`SpanExporter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"instrumentations","type":"Instrumentation<InstrumentationConfig>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
|
||||
<TypeList types={[{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exporter","type":"`SpanExporter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"instrument","type":"Partial<object>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflows","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"db","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"instrumentations","type":"Instrumentation<InstrumentationConfig>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"NodeSDK","type":"`NodeSDK`","optional":false,"defaultValue":"","description":"A helper function to configure the OpenTelemetry SDK with some defaults.\nFor better/more control, please configure the SDK manually.\n\nYou will have to install the following packages within your app for\ntelemetry to work\n\n- @opentelemetry/sdk-node\n- @opentelemetry/resources\n- @opentelemetry/sdk-trace-node\n- @opentelemetry/instrumentation-pg\n- @opentelemetry/instrumentation","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
|
||||
<TypeList types={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"A helper function to configure the OpenTelemetry SDK with some defaults.\nFor better/more control, please configure the SDK manually.\n\nYou will have to install the following packages within your app for\ntelemetry to work\n\n- @opentelemetry/sdk-node\n- @opentelemetry/resources\n- @opentelemetry/sdk-trace-node\n- @opentelemetry/instrumentation-pg\n- @opentelemetry/instrumentation","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
|
||||
@@ -6,7 +6,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customRemoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"[]","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new RemoteQuery"/>
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entitiesMap","type":"Map<string, any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customRemoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"[]","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new RemoteQuery"/>
|
||||
|
||||
___
|
||||
|
||||
@@ -18,6 +18,12 @@ ___
|
||||
|
||||
## Methods
|
||||
|
||||
### getEntitiesMap
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Map","type":"Map<string, any>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getEntitiesMap"/>
|
||||
|
||||
### setFetchDataCallback
|
||||
|
||||
#### Parameters
|
||||
|
||||
Reference in new issue
Block a user