chore(docs): Generated References (#6042)
Generated the following references: - `entities` - `fulfillment` - `inventory` - `js_client` - `medusa` - `medusa_react` - `modules` - `payment` - `pricing` - `product` - `services` - `stock_location` - `types` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Oli Juhl
Shahed Nasser
Oli Juhl
Shahed Nasser
parent
0b0c25da11
commit
6721633478
+89
@@ -0,0 +1,89 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# permanentFailure
|
||||
|
||||
Creates a StepResponse that indicates that the step has failed and the retry mechanism should not kick in anymore.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { Product } from "@medusajs/medusa"
|
||||
import {
|
||||
createStep,
|
||||
StepResponse,
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
|
||||
interface CreateProductInput {
|
||||
title: string
|
||||
}
|
||||
|
||||
export const createProductStep = createStep(
|
||||
"createProductStep",
|
||||
async function (
|
||||
input: CreateProductInput,
|
||||
context
|
||||
) {
|
||||
const productService = context.container.resolve(
|
||||
"productService"
|
||||
)
|
||||
|
||||
try {
|
||||
const product = await productService.create(input)
|
||||
return new StepResponse({
|
||||
product
|
||||
}, {
|
||||
product_id: product.id
|
||||
})
|
||||
} catch (e) {
|
||||
return StepResponse.permanentFailure(`Couldn't create the product: ${e}`)
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
interface WorkflowInput {
|
||||
title: string
|
||||
}
|
||||
|
||||
const myWorkflow = createWorkflow<
|
||||
WorkflowInput,
|
||||
Product
|
||||
>("my-workflow", (input) => {
|
||||
// Everything here will be executed and resolved later
|
||||
// during the execution. Including the data access.
|
||||
|
||||
const product = createProductStep(input)
|
||||
}
|
||||
)
|
||||
|
||||
myWorkflow()
|
||||
.run({
|
||||
input: {
|
||||
title: "Shirt"
|
||||
}
|
||||
})
|
||||
.then(({ errors, result }) => {
|
||||
if (errors.length) {
|
||||
errors.forEach((err) => {
|
||||
if (typeof err.error === "object" && "message" in err.error) {
|
||||
console.error(err.error.message)
|
||||
} else {
|
||||
console.error(err.error)
|
||||
}
|
||||
})
|
||||
}
|
||||
console.log(result)
|
||||
})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"message","type":"`string`","description":"An optional message to be logged.","optional":false,"defaultValue":"\"Permanent failure\"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"never","type":"`never`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
@@ -12,6 +12,10 @@ This class is used to create the response returned by a step. A step return its
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TOutput","type":"`object`","description":"The type of the output of the step.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Methods
|
||||
|
||||
- [permanentFailure](../StepResponse/methods/workflows.StepResponse.permanentFailure.mdx)
|
||||
|
||||
## constructor
|
||||
|
||||
The constructor of the StepResponse
|
||||
@@ -22,4 +26,4 @@ The constructor of the StepResponse
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"output","type":"`TOutput`","description":"The output of the step.","optional":false,"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":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"output","type":"TOutput","description":"The output of the step.","optional":false,"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":[]}]} />
|
||||
|
||||
@@ -60,7 +60,7 @@ export const createProductStep = createStep(
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"InvokeFn<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>","description":"An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../classes/workflows.StepResponse.mdx). The constructor of [StepResponse](../classes/workflows.StepResponse.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"CompensateFn<TInvokeResultCompensateInput>","description":"A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../classes/workflows.StepResponse.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"nameOrConfig","type":"`string` \\| `object` & Pick<TransactionStepsDefinition, \"maxRetries\">","description":"The name of the step or its configuration (currently support maxRetries).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"InvokeFn<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>","description":"An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../classes/workflows.StepResponse.mdx). The constructor of [StepResponse](../classes/workflows.StepResponse.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"CompensateFn<TInvokeResultCompensateInput>","description":"A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../classes/workflows.StepResponse.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -66,7 +66,7 @@ export async function GET(
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"The name of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"composer","type":"(`input`: [WorkflowData](../types/workflows.WorkflowData.mdx)<TData>) => `void` \\| [WorkflowData](../types/workflows.WorkflowData.mdx)<TResult> \\| { [K in string \\| number \\| symbol]: WorkflowDataProperties<TResult[K]> \\| WorkflowData<TResult[K]> }","description":"The constructor function that is executed when the `run` method in ReturnWorkflow is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](workflows.transform.mdx) function if you need to directly manipulate data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"The name of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"composer","type":"(`input`: [WorkflowData](../types/workflows.WorkflowData.mdx)<TData>) => `void` \\| [WorkflowData](../types/workflows.WorkflowData.mdx)<TResult> \\| { [K in string \\| number \\| symbol]: WorkflowDataProperties<TResult[K]> \\| WorkflowData<TResult[K]> }","description":"The constructor function that is executed when the `run` method in ReturnWorkflow is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](workflows.transform.mdx) function if you need to directly manipulate data.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`TransactionModelOptions`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -53,8 +53,8 @@ const myWorkflow = createWorkflow<
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"steps","type":"`TResult`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"steps","type":"TResult","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TResult","type":"`TResult`","optional":false,"defaultValue":"","description":"The step results. The results are ordered in the array by the order they're passed in the function's parameter.","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"TResult","type":"TResult","optional":false,"defaultValue":"","description":"The step results. The results are ordered in the array by the order they're passed in the function's parameter.","expandable":false,"children":[]}]} />
|
||||
|
||||
@@ -59,7 +59,7 @@ const myWorkflow = createWorkflow<
|
||||
|
||||
## Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"values","type":"`T`","description":"The output(s) of other step functions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"func","type":"[Func1<T, RFinal>]","description":"The transform function used to perform action on the runtime values of the provided `values`.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"values","type":"T","description":"The output(s) of other step functions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"func","type":"[Func1<T, RFinal>]","description":"The transform function used to perform action on the runtime values of the provided `values`.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The step's context.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../types/interfaces/types.Context.mdx)","description":"A shared context object that is used to share resources between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"`TManager`","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager","type":"`TManager`","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../types/interfaces/types.Context.mdx)","description":"A shared context object that is used to share resources between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
+1
-1
@@ -10,4 +10,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Type declaration
|
||||
|
||||
<ParameterTypes parameters={[{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => `TOutput`) => `TOutput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](workflows.StepFunctionResult.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](workflows.StepFunctionResult.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StepFunction
|
||||
|
||||
**StepFunction**: (`input`: { [K in string \| number \| symbol]: WorkflowData<TInput[K]> }) => [WorkflowData](workflows.WorkflowData.mdx)<{ [K in string \| number \| symbol]: TOutput[K] }> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
**StepFunction**: keyof TInput extends [] ? () => [WorkflowData](workflows.WorkflowData.mdx)<{ [K in string \| number \| symbol]: TOutput[K] }> : (`input`: TInput extends `object` ? { [K in string \| number \| symbol]: TInput[K] \| WorkflowData<TInput[K]> } : TInput \| [WorkflowData](workflows.WorkflowData.mdx)<TInput>) => [WorkflowData](workflows.WorkflowData.mdx)<{ [K in string \| number \| symbol]: TOutput[K] }> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<{ [K in keyof TOutput]: TOutput[K] }> & `object` & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
|
||||
A step function to be used in a workflow.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StepFunctionResult
|
||||
|
||||
**StepFunctionResult**: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => `TOutput` extends [] ? [...WorkflowData<{ [K in keyof TOutput]: TOutput[number][K] }>[]] : [WorkflowData](workflows.WorkflowData.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
**StepFunctionResult**: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
|
||||
## Type Parameters
|
||||
|
||||
@@ -16,8 +16,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"[CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => `TOutput`) => `TOutput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](workflows.StepFunctionResult.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"this","type":"[CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](workflows.StepFunctionResult.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
|
||||
### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TOutput extends [] ? [...WorkflowData<{ [K in keyof TOutput]: TOutput[number][K] }>[]] : WorkflowData<{ [K in keyof TOutput]: TOutput[K] }>","type":"`TOutput` extends [] ? [...WorkflowData<{ [K in keyof TOutput]: TOutput[number][K] }>[]] : [WorkflowData](workflows.WorkflowData.mdx)<{ [K in keyof TOutput]: TOutput[K] }>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"WorkflowData","type":"[WorkflowData](workflows.WorkflowData.mdx)<{ [K in keyof TOutput]: TOutput[K] }>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"{ [K in keyof TOutput]: TOutput[K] }","type":"{ [K in keyof TOutput]: TOutput[K] }","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} />
|
||||
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# WorkflowData
|
||||
|
||||
**WorkflowData**: `T` extends `object` ? { [Key in keyof T]: WorkflowData<T[Key]> } : [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T>
|
||||
**WorkflowData**: T extends `object` ? { [Key in keyof T]: WorkflowData<T[Key]> } : [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T>
|
||||
|
||||
This type is used to encapsulate the input or output type of all utils.
|
||||
|
||||
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolInputReference
|
||||
|
||||
`Const` **SymbolInputReference**: typeof [SymbolInputReference](workflows.SymbolInputReference.mdx)
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolMedusaWorkflowComposerContext
|
||||
|
||||
`Const` **SymbolMedusaWorkflowComposerContext**: typeof [SymbolMedusaWorkflowComposerContext](workflows.SymbolMedusaWorkflowComposerContext.mdx)
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowHook
|
||||
|
||||
`Const` **SymbolWorkflowHook**: typeof [SymbolWorkflowHook](workflows.SymbolWorkflowHook.mdx)
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowStep
|
||||
|
||||
`Const` **SymbolWorkflowStep**: typeof [SymbolWorkflowStep](workflows.SymbolWorkflowStep.mdx)
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowStepBind
|
||||
|
||||
`Const` **SymbolWorkflowStepBind**: typeof [SymbolWorkflowStepBind](workflows.SymbolWorkflowStepBind.mdx)
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowStepResponse
|
||||
|
||||
`Const` **SymbolWorkflowStepResponse**: typeof [SymbolWorkflowStepResponse](workflows.SymbolWorkflowStepResponse.mdx)
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowStepTransformer
|
||||
|
||||
`Const` **SymbolWorkflowStepTransformer**: typeof [SymbolWorkflowStepTransformer](workflows.SymbolWorkflowStepTransformer.mdx)
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: workflowsSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SymbolWorkflowWorkflowData
|
||||
|
||||
`Const` **SymbolWorkflowWorkflowData**: typeof [SymbolWorkflowWorkflowData](workflows.SymbolWorkflowWorkflowData.mdx)
|
||||
Reference in New Issue
Block a user