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

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
www/apps/docs/content/references/workflows/classes/workflows.StepResponse.mdx
View File

@@ -10,26 +10,7 @@ This class is used to create the response returned by a step. A step return its
## Type parameters
<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": []
}
]} />
<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":[]}]} />
## constructor
@@ -37,46 +18,8 @@ The constructor of the StepResponse
### Type Parameters
<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": []
}
]} />
<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":[]}]} />
### 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":[]}]} />