chore(docs): Generated References (#5743)
Generated the following references: - `entities` - `inventory` - `js-client` - `pricing` - `product` - `services` - `stock-location` - `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:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -58,9 +58,9 @@ asyncResource.triggerAsyncId();
|
||||
|
||||
## Methods
|
||||
|
||||
### asyncId
|
||||
#### asyncId
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -76,11 +76,11 @@ asyncResource.triggerAsyncId();
|
||||
|
||||
___
|
||||
|
||||
### bind
|
||||
#### bind
|
||||
|
||||
Binds the given function to execute to this `AsyncResource`'s scope.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -94,9 +94,19 @@ Binds the given function to execute to this `AsyncResource`'s scope.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Func",
|
||||
"type": "`Func`",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Since
|
||||
|
||||
@@ -104,14 +114,14 @@ v14.8.0, v12.19.0
|
||||
|
||||
___
|
||||
|
||||
### emitDestroy
|
||||
#### emitDestroy
|
||||
|
||||
Call all `destroy` hooks. This should only ever be called once. An error will
|
||||
be thrown if it is called more than once. This **must** be manually called. If
|
||||
the resource is left to be collected by the GC then the `destroy` hooks will
|
||||
never be called.
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -127,14 +137,14 @@ never be called.
|
||||
|
||||
___
|
||||
|
||||
### runInAsyncScope
|
||||
#### runInAsyncScope
|
||||
|
||||
Call the provided function with the provided arguments in the execution context
|
||||
of the async resource. This will establish the context, trigger the AsyncHooks
|
||||
before callbacks, call the function, trigger the AsyncHooks after callbacks, and
|
||||
then restore the original execution context.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -166,9 +176,19 @@ then restore the original execution context.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Result",
|
||||
"type": "`Result`",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Since
|
||||
|
||||
@@ -176,9 +196,9 @@ v9.6.0
|
||||
|
||||
___
|
||||
|
||||
### triggerAsyncId
|
||||
#### triggerAsyncId
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user