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

chore(docs): Generated References (#5743)

Browse Source 
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:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
www/apps/docs/content/references/js-client/EventEmitter/classes/internal.EventEmitter.EventEmitterAsyncResource.mdx
View File

@@ -91,9 +91,9 @@ v17.4.0, v16.14.0
## Methods
### [captureRejectionSymbol]
#### [captureRejectionSymbol]
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -125,7 +125,7 @@ v17.4.0, v16.14.0
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -141,11 +141,11 @@ v17.4.0, v16.14.0
___
### addListener
#### addListener
Alias for `emitter.on(eventName, listener)`.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -168,7 +168,7 @@ Alias for `emitter.on(eventName, listener)`.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -188,7 +188,7 @@ v0.1.26
___
### emit
#### emit
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -228,7 +228,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
// event with parameters 1, 2, 3, 4, 5 in third listener
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -251,7 +251,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -271,14 +271,14 @@ v0.1.26
___
### 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={[
{
@@ -294,7 +294,7 @@ the destroy hooks will never be called.
___
### eventNames
#### eventNames
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -313,7 +313,7 @@ console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -333,12 +333,12 @@ v6.0.0
___
### getMaxListeners
#### getMaxListeners
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal.EventEmitter.EventEmitterAsyncResource.mdx#defaultmaxlisteners).
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -358,13 +358,13 @@ v1.0.0
___
### listenerCount
#### listenerCount
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
in the list of the listeners of the event.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -387,7 +387,7 @@ in the list of the listeners of the event.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -407,7 +407,7 @@ v3.2.0
___
### listeners
#### listeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -419,7 +419,7 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -433,7 +433,7 @@ console.log(util.inspect(server.listeners('connection')));
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -453,11 +453,11 @@ v0.1.26
___
### off
#### off
Alias for `emitter.removeListener()`.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -480,7 +480,7 @@ Alias for `emitter.removeListener()`.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -500,7 +500,7 @@ v10.0.0
___
### on
#### on
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -529,7 +529,7 @@ myEE.emit('foo');
// a
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -552,7 +552,7 @@ myEE.emit('foo');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -572,7 +572,7 @@ v0.1.101
___
### once
#### once
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -599,7 +599,7 @@ myEE.emit('foo');
// a
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -622,7 +622,7 @@ myEE.emit('foo');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -642,7 +642,7 @@ v0.3.0
___
### prependListener
#### prependListener
Adds the `listener` function to the \_beginning\_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -657,7 +657,7 @@ server.prependListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -680,7 +680,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -700,7 +700,7 @@ v6.0.0
___
### prependOnceListener
#### prependOnceListener
Adds a **one-time**`listener` function for the event named `eventName` to the \_beginning\_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -713,7 +713,7 @@ server.prependOnceListener('connection', (stream) => {
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -736,7 +736,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -756,7 +756,7 @@ v6.0.0
___
### rawListeners
#### rawListeners
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -786,7 +786,7 @@ newListeners[0]();
emitter.emit('log');
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -800,7 +800,7 @@ emitter.emit('log');
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -820,7 +820,7 @@ v9.4.0
___
### removeAllListeners
#### removeAllListeners
Removes all listeners, or those of the specified `eventName`.
@@ -830,7 +830,7 @@ component or module (e.g. sockets or file streams).
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -844,7 +844,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -864,7 +864,7 @@ v0.1.26
___
### removeListener
#### removeListener
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -946,7 +946,7 @@ ee.emit('ping');
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -969,7 +969,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -989,7 +989,7 @@ v0.1.26
___
### setMaxListeners
#### setMaxListeners
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -998,7 +998,7 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
Returns a reference to the `EventEmitter`, so that calls can be chained.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1012,7 +1012,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1032,7 +1032,7 @@ v0.3.5
___
### addAbortListener
#### addAbortListener
Listens once to the `abort` event on the provided `signal`.
@@ -1064,7 +1064,7 @@ function example(signal) {
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1087,7 +1087,7 @@ function example(signal) {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1107,7 +1107,7 @@ v20.5.0
___
### getEventListeners
#### getEventListeners
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1134,7 +1134,7 @@ import { getEventListeners, EventEmitter } from 'node:events';
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1157,7 +1157,7 @@ import { getEventListeners, EventEmitter } from 'node:events';
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1177,7 +1177,7 @@ v15.2.0, v14.17.0
___
### getMaxListeners
#### getMaxListeners
Returns the currently set max amount of listeners.
@@ -1205,7 +1205,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
}
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1219,7 +1219,7 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1239,7 +1239,7 @@ v19.9.0
___
### listenerCount
#### listenerCount
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -1253,7 +1253,7 @@ console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1276,7 +1276,7 @@ console.log(listenerCount(myEmitter, 'event'));
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1300,7 +1300,7 @@ Since v3.2.0 - Use `listenerCount` instead.
___
### on
#### on
```js
import { on, EventEmitter } from 'node:events';
@@ -1357,7 +1357,7 @@ const ac = new AbortController();
process.nextTick(() => ac.abort());
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1389,7 +1389,7 @@ process.nextTick(() => ac.abort());
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1409,7 +1409,7 @@ v13.6.0, v12.16.0
___
### once
#### once
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;`
@@ -1490,7 +1490,7 @@ ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1522,7 +1522,7 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1542,7 +1542,7 @@ v11.13.0, v10.16.0
`Static **once**(emitter, eventName, options?): Promise&#60;any[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1574,7 +1574,7 @@ v11.13.0, v10.16.0
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -1590,7 +1590,7 @@ v11.13.0, v10.16.0
___
### setMaxListeners
#### setMaxListeners
```js
import { setMaxListeners, EventEmitter } from 'node:events';
@@ -1601,7 +1601,7 @@ const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1624,7 +1624,7 @@ setMaxListeners(5, target, emitter);
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{

48
www/apps/docs/content/references/js-client/EventEmitter/interfaces/internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx
View File

@@ -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={[
{