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

chore(docs): Generated References (automated) (#8642)

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-08-18 16:54:36 +02:00
1 parent 4980285317
commit fb0644b8f6
2734 files changed
+131045 -127334
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/workflows/classes/workflows.StepResponse/page.mdx
+3 -3
View File
@@ -6,7 +6,7 @@ This class is used to create the response returned by a step. A step return its
## Type parameters
<TypeList types={[{"name":"TOutput","type":"`object`","description":"The type of the output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TCompensateInput","type":"`object`","description":"The type of the compensation input. If the step doesn't specify any compensation input, then the type of `TCompensateInput` is the same\nas that of `TOutput`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="StepResponse"/>
<TypeList types={[{"name":"TOutput","type":"`object`","description":"The type of the output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TCompensateInput","type":"`object`","description":"The type of the compensation input. If the step doesn't specify any compensation input, then the type of `TCompensateInput` is the same\nas that of `TOutput`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepResponse"/>
## Constructors
@@ -23,8 +23,8 @@ The constructor of the StepResponse
### Type Parameters
<TypeList types={[{"name":"TOutput","type":"`object`","description":"The type of the output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TCompensateInput","type":"`object`","description":"The type of the compensation input. If the step doesn't specify any compensation input, then the type of `TCompensateInput` is the same\nas that of `TOutput`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new StepResponse"/>
<TypeList types={[{"name":"TOutput","type":"`object`","description":"The type of the output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TCompensateInput","type":"`object`","description":"The type of the compensation input. If the step doesn't specify any compensation input, then the type of `TCompensateInput` is the same\nas that of `TOutput`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new StepResponse"/>
### Parameters
<TypeList types={[{"name":"output","type":"TOutput","description":"The output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateInput","type":"TCompensateInput","description":"The input to be passed as a parameter to the step's compensation function. If not provided, the `output` will be provided instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new StepResponse"/>
<TypeList types={[{"name":"output","type":"TOutput","description":"The output of the step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateInput","type":"TCompensateInput","description":"The input to be passed as a parameter to the step's compensation function. If not provided, the `output` will be provided instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new StepResponse"/>
www/apps/resources/references/workflows/classes/workflows.WorkflowResponse/page.mdx
+4 -4
View File
@@ -6,18 +6,18 @@ Workflow response class encapsulates the return value of a workflow
## Type parameters
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="WorkflowResponse"/>
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","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="WorkflowResponse"/>
## constructor
### Type Parameters
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new WorkflowResponse"/>
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","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 WorkflowResponse"/>
### Parameters
<TypeList types={[{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="new WorkflowResponse"/>
<TypeList types={[{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new WorkflowResponse"/>
___
<TypeList types={[{"name":"__type","type":"`string`","description":"","optional":false,"defaultValue":"OrchestrationUtils.SymbolMedusaWorkflowResponse","expandable":false,"children":[]},{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="WorkflowResponse"/>
<TypeList types={[{"name":"__type","type":"`string`","description":"","optional":false,"defaultValue":"OrchestrationUtils.SymbolMedusaWorkflowResponse","expandable":false,"children":[]},{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="WorkflowResponse"/>