docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
@@ -56,11 +56,13 @@ asyncResource.triggerAsyncId();
}
]} />
___
## Methods
#### asyncId
### asyncId
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -76,11 +78,11 @@ asyncResource.triggerAsyncId();
___
#### bind
### bind
Binds the given function to execute to this `AsyncResource`'s scope.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -94,7 +96,7 @@ Binds the given function to execute to this `AsyncResource`'s scope.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -114,14 +116,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={[
{
@@ -137,14 +139,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={[
{
@@ -176,7 +178,7 @@ then restore the original execution context.
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -196,9 +198,9 @@ v9.6.0
___
#### triggerAsyncId
### triggerAsyncId
##### Returns
#### Returns
<ParameterTypes parameters={[
{