chore(docs): Generated References (#6904)
Generated the following references: - `inventory` - `js_client` - `medusa` - `medusa_config` - `medusa_react` - `modules` - `payment` - `pricing` - `product` - `services` - `stock_location` - `tax_calculation` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
85e5478873
commit
7fe164bc1d
@@ -31,7 +31,7 @@ export const createProductStep = createStep(
|
||||
const productService = context.container.resolve(
|
||||
"productService"
|
||||
)
|
||||
|
||||
|
||||
try {
|
||||
const product = await productService.create(input)
|
||||
return new StepResponse({
|
||||
|
||||
@@ -8,4 +8,4 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
The step's context.
|
||||
|
||||
<TypeList types={[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-2.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../types/interfaces/types.Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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":"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":"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":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","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":"messageAggregator","type":"[IMessageAggregator](../../types/interfaces/types.IMessageAggregator.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="StepExecutionContext"/>
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-2.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../types/interfaces/types.Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"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":"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":"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":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","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":"messageAggregator","type":"[IMessageAggregator](../../types/interfaces/types.IMessageAggregator.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="StepExecutionContext"/>
|
||||
|
||||
@@ -6,7 +6,7 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# StepFunction
|
||||
|
||||
**StepFunction**: keyof TInput extends [] ? () => TOutput extends `Item`[] ? (`Item` \| [WorkflowData](workflows.WorkflowData.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: TOutput[Key] \| WorkflowData<TOutput[Key]> } : TOutput & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<TOutput> & TOutput & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<TOutput> & ``{ config: Method config }`` & StepFunctionReturnConfig<TOutput> : (`input`: TInput \| [WorkflowData](workflows.WorkflowData.mdx)<TInput>) => TOutput extends `Item`[] ? (`Item` \| [WorkflowData](workflows.WorkflowData.mdx)<Item>)[] : TOutput extends `object` ? { [Key in string \| number \| symbol]: TOutput[Key] \| WorkflowData<TOutput[Key]> } : TOutput & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<TOutput> & TOutput & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<TOutput> & ``{ config: Method config }`` & StepFunctionReturnConfig<TOutput> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<TOutput>
|
||||
**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] }> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
|
||||
A step function to be used in a workflow.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# StepFunctionResult
|
||||
|
||||
**StepFunctionResult**: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<TOutput>
|
||||
**StepFunctionResult**: (`this`: [CreateWorkflowComposerContext](workflows.CreateWorkflowComposerContext.mdx)) => [WorkflowData](workflows.WorkflowData.mdx)<{ [K in keyof TOutput]: TOutput[K] }>
|
||||
|
||||
## Type Parameters
|
||||
|
||||
@@ -20,4 +20,4 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"WorkflowData","type":"[WorkflowData](workflows.WorkflowData.mdx)<TOutput>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TOutput","type":"TOutput","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
<TypeList types={[{"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":[]}]}]} sectionTitle="__type"/>
|
||||
|
||||
@@ -6,7 +6,7 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# WorkflowData
|
||||
|
||||
**WorkflowData**: T extends infer Item[] ? (`Item` \| [WorkflowData](workflows.WorkflowData.mdx)<Item>)[] : T extends `object` ? { [Key in keyof T]: T[Key] \| WorkflowData<T[Key]> } : T & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & T & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & `object`
|
||||
**WorkflowData**: T extends `object` ? { [Key in keyof T]: WorkflowData<T[Key]> } : [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & [WorkflowDataProperties](workflows.WorkflowDataProperties.mdx)<T> & `object`
|
||||
|
||||
This type is used to encapsulate the input or output type of all utils.
|
||||
|
||||
|
||||
@@ -14,4 +14,4 @@ import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"__type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="WorkflowDataProperties"/>
|
||||
<TypeList types={[{"name":"__type","type":"`Symbol`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="WorkflowDataProperties"/>
|
||||
|
||||
Reference in New Issue
Block a user