docs: generate references manually for 2.12.3 (#14340)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
52e965f411
commit
1c4c4b8e9a
1080 files changed
+394731
-361464
No files matched your search
@@ -59,4 +59,4 @@ ___
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"container_","type":"[MedusaContainer](../../types/workflows.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"contextualizedMedusaModules","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customOptions","type":"Partial<[TransactionModelOptions](../../types/workflows.TransactionModelOptions/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"timeout","type":"`number`","description":"The global timeout for the entire transaction workflow (in seconds).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"`boolean`","description":"If true, the state of the transaction will be persisted.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retentionTime","type":"`number`","description":"The number of seconds that the workflow execution should be stored in the database.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"storeExecution","type":"`boolean`","description":"If true, the execution details of each step will be stored.","optional":true,"defaultValue":"","expandable":false,"children":[],"deprecated":{"is_deprecated":true,"description":"no longer needed."}},{"name":"idempotent","type":"`boolean`","description":"If true, the workflow will use the transaction ID as the key to ensure only-once execution","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schedule","type":"`string` \\| [SchedulerOptions](../../types/workflows.SchedulerOptions/page.mdx)","description":"Defines the workflow as a scheduled workflow that executes based on the cron configuration passed.\nThe value can either by a cron expression string, or an object that also allows to define the concurrency behavior.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"flow","type":"[OrchestratorBuilder](../workflows.OrchestratorBuilder/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"steps","type":"[InternalStep](../../interfaces/workflows.InternalStep/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasChanges_","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"handlers","type":"Map<string, [StepHandler](../../types/workflows.StepHandler/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"invoke","type":"[WorkflowStepHandler](../../types/workflows.WorkflowStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"[WorkflowStepHandler](../../types/workflows.WorkflowStepHandler/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"onLoad","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registerEventCallbacks","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resolveContainer","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflow","type":"[WorkflowDefinition](../../interfaces/workflows.WorkflowDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handler","type":"(`container`: [MedusaContainer](../../types/workflows.MedusaContainer/page.mdx), `context?`: [Context](../../interfaces/workflows.Context/page.mdx)) => [TransactionStepHandler](../../types/workflows.TransactionStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orchestrator","type":"[TransactionOrchestrator](../workflows.TransactionOrchestrator/page.mdx)","description":"TransactionOrchestrator is responsible for managing and executing distributed transactions.\nIt is based on a single transaction definition, which is used to execute all the transaction steps","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow_","type":"[TransactionStepsDefinition](../../types/workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":fLine truncated
|
||||
<TypeList types={[{"name":"container_","type":"[MedusaContainer](../../types/workflows.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"contextualizedMedusaModules","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customOptions","type":"Partial<[TransactionModelOptions](../../types/workflows.TransactionModelOptions/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"timeout","type":"`number`","description":"The global timeout for the entire transaction workflow (in seconds).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"`boolean`","description":"If true, the state of the transaction will be persisted.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"retentionTime","type":"`number`","description":"The number of seconds that the workflow execution should be stored in the database.\n\nLearn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"storeExecution","type":"`boolean`","description":"If true, the execution details of each step will be stored.","optional":true,"defaultValue":"","expandable":false,"children":[],"deprecated":{"is_deprecated":true,"description":"no longer needed."}},{"name":"idempotent","type":"`boolean`","description":"If true, the workflow will use the transaction ID as the key to ensure only-once execution","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schedule","type":"`string` \\| [SchedulerOptions](../../types/workflows.SchedulerOptions/page.mdx)","description":"Defines the workflow as a scheduled workflow that executes based on the cron configuration passed.\nThe value can either by a cron expression string, or an object that also allows to define the concurrency behavior.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"flow","type":"[OrchestratorBuilder](../workflows.OrchestratorBuilder/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"steps","type":"[InternalStep](../../interfaces/workflows.InternalStep/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasChanges_","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"handlers","type":"Map<string, [StepHandler](../../types/workflows.StepHandler/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"invoke","type":"[WorkflowStepHandler](../../types/workflows.WorkflowStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"[WorkflowStepHandler](../../types/workflows.WorkflowStepHandler/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"onLoad","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registerEventCallbacks","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resolveContainer","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflow","type":"[WorkflowDefinition](../../interfaces/workflows.WorkflowDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handler","type":"(`container`: [MedusaContainer](../../types/workflows.MedusaContainer/page.mdx), `context?`: [Context](../../interfaces/workflows.Context/page.mdx)) => [TransactionStepHandler](../../types/workflows.TransactionStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orchestrator","type":"[TransactionOrchestrator](../workflows.TransactionOrchestrator/page.mdx)","description":"TransactionOrchestrator is responsible for managing and executing distributed transactions.\nIt is based on a single transaction definition, which is used to execute all the transaction steps","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow_","type":"[TransactionStepsDefinition](../../types/workflows.TransactionStepsDefinitionLine truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
<TypeList types={[{"name":"TOptions","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="LoaderOptions"/>
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../interfaces/workflows.Logger/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="LoaderOptions"/>
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../interfaces/workflows.Logger/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="LoaderOptions"/>
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ModuleExports"/>
|
||||
|
||||
<TypeList types={[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../workflows.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runMigrations","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigration","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigration","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discoveryPath","type":"`string`","description":"Explicitly set the the true location of the module resources.\nCan be used to re-export the module from a different location and specify its original location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ModuleExports"/>
|
||||
<TypeList types={[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../workflows.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runMigrations","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)) => Promise<{ name: string ; path: string }[]>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigration","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx), `migrationNames?`: `string`[]) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigration","type":"(`options`: [LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discoveryPath","type":"`string`","description":"Explicitly set the the true location of the module resources.\nCan be used to re-export the module from a different location and specify its original location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ModuleExports"/>
|
||||
+1
-1
@@ -6,7 +6,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"options","type":"[LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../interfaces/workflows.Logger/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../workflows.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../workflows.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"options","type":"[LoaderOptions](../workflows.LoaderOptions/page.mdx)<any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../interfaces/workflows.Logger/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../workflows.InternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../workflows.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../workflows.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"args","type":"[WorkflowStepHandlerArguments](../workflows.WorkflowStepHandlerArguments/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[TransactionMetadata](../workflows.TransactionMetadata/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transaction","type":"[DistributedTransaction](../../classes/workflows.DistributedTransaction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"step","type":"[TransactionStep](../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orchestrator","type":"[TransactionOrchestrator](../../classes/workflows.TransactionOrchestrator/page.mdx)","description":"TransactionOrchestrator is responsible for managing and executing distributed transactions.\nIt is based on a single transaction definition, which is used to execute all the transaction steps","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../interfaces/workflows.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"args","type":"[WorkflowStepHandlerArguments](../workflows.WorkflowStepHandlerArguments/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[TransactionMetadata](../workflows.TransactionMetadata/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transaction","type":"[DistributedTransaction](../../classes/workflows.DistributedTransaction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"step","type":"[TransactionStep](../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orchestrator","type":"[TransactionOrchestrator](../../classes/workflows.TransactionOrchestrator/page.mdx)","description":"TransactionOrchestrator is responsible for managing and executing distributed transactions.\nIt is based on a single transaction definition, which is used to execute all the transaction steps","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../interfaces/workflows.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**WorkflowStepHandlerArguments**: `Object`
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[TransactionMetadata](../workflows.TransactionMetadata/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"model_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action_type","type":"[TransactionHandlerType](../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timestamp","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"transaction","type":"[DistributedTransaction](../../classes/workflows.DistributedTransaction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"#private","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handler","type":"[TransactionStepHandler](../workflows.TransactionStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modelId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keyValueStore","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keyPrefix","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"step","type":"[TransactionStep](../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"temporaryFailedAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasScheduledRetry","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable"Line truncated
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../workflows.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[TransactionMetadata](../workflows.TransactionMetadata/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"model_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action_type","type":"[TransactionHandlerType](../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timestamp","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"transaction","type":"[DistributedTransaction](../../classes/workflows.DistributedTransaction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"#private","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handler","type":"[TransactionStepHandler](../workflows.TransactionStepHandler/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modelId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keyValueStore","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keyPrefix","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"step","type":"[TransactionStep](../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"temporaryFailedAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"chLine truncated
|
||||
Reference in new issue
Block a user