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

docs: revise main docs outline (#10502)

Browse Source
This commit is contained in:
Shahed Nasser
2024-12-09 13:54:42 +02:00
committed by GitHub
parent c8cb9b5c1a
commit 0ae98c51eb
141 changed files with 814 additions and 1181 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/workflows/functions/workflows.createHook/page.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ Expose a hook in your workflow where you can inject custom functionality as a st
A handler hook can later be registered to consume the hook and perform custom functionality.
Learn more in [this documentation](https://docs.medusajs.com/advanced-development/workflows/add-workflow-hook).
Learn more in [this documentation](https://docs.medusajs.com/fundamentals/workflows/add-workflow-hook).
## Example
www/apps/resources/references/workflows/types/workflows.UnwrapWorkflowInputDataType/page.mdx
+1 -1
View File
@@ -14,4 +14,4 @@ type WorkflowInputData = UnwrapWorkflowInputDataType<typeof myWorkflow>
## Type Parameters
<TypeList types={[{"name":"T","type":"[ReturnWorkflow](../workflows.ReturnWorkflow/page.mdx)&#60;any, any, any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"runAsStep","type":"(`{\n input,\n }`: ``{ input: TData \\| [WorkflowData](../workflows.WorkflowData/page.mdx)&#60;TData&#62; }``) => ReturnType&#60;[StepFunction](../workflows.StepFunction/page.mdx)&#60;TData, TResult&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"run","type":"`<TDataOverride, TResultOverride>`(...`args`: Parameters&#60;ExportedWorkflow&#60;TData, TResult, TDataOverride, TResultOverride&#62;[\"run\"]&#62;) => ReturnType&#60;ExportedWorkflow&#60;TData, TResult, TDataOverride, TResultOverride&#62;[\"run\"]&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"getName","type":"() => `string`","description":"This method retrieves the workflow's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"(`config`: `TransactionModelOptions`) => `void`","description":"This method sets the workflow's configurations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks","type":"ConvertHooksToFunctions&#60;THooks&#62;","description":"The workflow's exposed hooks, used to register a handler to consume the hook.\n\nLearn more in [this documentation](https://docs.medusajs.com/advanced-development/workflows/add-workflow-hook#how-to-consume-a-hook).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UnwrapWorkflowInputDataType"/>
<TypeList types={[{"name":"T","type":"[ReturnWorkflow](../workflows.ReturnWorkflow/page.mdx)&#60;any, any, any&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"runAsStep","type":"(`{\n input,\n }`: ``{ input: TData \\| [WorkflowData](../workflows.WorkflowData/page.mdx)&#60;TData&#62; }``) => ReturnType&#60;[StepFunction](../workflows.StepFunction/page.mdx)&#60;TData, TResult&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"run","type":"`<TDataOverride, TResultOverride>`(...`args`: Parameters&#60;ExportedWorkflow&#60;TData, TResult, TDataOverride, TResultOverride&#62;[\"run\"]&#62;) => ReturnType&#60;ExportedWorkflow&#60;TData, TResult, TDataOverride, TResultOverride&#62;[\"run\"]&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"getName","type":"() => `string`","description":"This method retrieves the workflow's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"(`config`: `TransactionModelOptions`) => `void`","description":"This method sets the workflow's configurations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks","type":"ConvertHooksToFunctions&#60;THooks&#62;","description":"The workflow's exposed hooks, used to register a handler to consume the hook.\n\nLearn more in [this documentation](https://docs.medusajs.com/fundamentals/workflows/add-workflow-hook#how-to-consume-a-hook).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UnwrapWorkflowInputDataType"/>