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

chore(docs): Generated References (#5602)

Browse Source 
Generated the following references:
- `pricing`
- `product`

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-10 17:31:02 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 5f4317b9d7
commit 39649b3552
2110 changed files with 148777 additions and 4448445 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/EventEmitter/classes/internal.EventEmitter.EventEmitterAsyncResource.mdx
+17 -299
View File
@@ -40,91 +40,7 @@ v17.4.0, v16.14.0
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "eventEmitter",
"type": "[`EventEmitterAsyncResource`](internal.EventEmitter.EventEmitterAsyncResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "asyncId",
"type": "`number`",
"description": "The unique asyncId assigned to the resource.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "asyncResource",
"type": "[`EventEmitterReferencingAsyncResource`](../interfaces/internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
"description": "The underlying AsyncResource",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "eventEmitter",
"type": "[`EventEmitterAsyncResource`](internal.EventEmitter.EventEmitterAsyncResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "triggerAsyncId",
"type": "`number`",
"description": "The same triggerAsyncId that is passed to the AsyncResource constructor.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](../../internal/classes/internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
"children": []
},
{
"name": "triggerAsyncId",
@@ -187,35 +103,7 @@ v17.4.0, v16.14.0
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "message",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stack",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "event",
@@ -276,17 +164,7 @@ Alias for `emitter.on(eventName, listener)`.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -445,17 +323,7 @@ console.log(myEE.eventNames());
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "string \\| symbol",
"type": "`string` \\| `symbol`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -608,17 +476,7 @@ Alias for `emitter.removeListener()`.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -690,17 +548,7 @@ myEE.emit('foo');
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -770,17 +618,7 @@ myEE.emit('foo');
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -838,17 +676,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -904,17 +732,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1147,17 +965,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(...`args`: `any`[]) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1275,17 +1083,7 @@ function example(signal) {
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(`event`: `Event`) => `void`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1587,17 +1385,7 @@ process.nextTick(() => ac.abort());
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "signal",
"type": "`AbortSignal`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1611,17 +1399,7 @@ process.nextTick(() => ac.abort());
"defaultValue": "",
"description": "that iterates `eventName` events emitted by the `emitter`",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1740,17 +1518,7 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "signal",
"type": "`AbortSignal`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1764,27 +1532,7 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any[]",
"type": "`any`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
"children": []
}
]} />
@@ -1822,17 +1570,7 @@ v11.13.0, v10.16.0
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "signal",
"type": "`AbortSignal`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -1846,27 +1584,7 @@ v11.13.0, v10.16.0
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any[]",
"type": "`any`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]
"children": []
}
]} />
www/apps/docs/content/references/js-client/EventEmitter/interfaces/internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx
+2 -150
View File
@@ -52,145 +52,7 @@ asyncResource.triggerAsyncId();
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "asyncId",
"type": "`number`",
"description": "The unique asyncId assigned to the resource.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "asyncResource",
"type": "[`EventEmitterReferencingAsyncResource`](internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
"description": "The underlying AsyncResource",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "eventEmitter",
"type": "[`EventEmitterAsyncResource`](../classes/internal.EventEmitter.EventEmitterAsyncResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "asyncId",
"type": "`number`",
"description": "The unique asyncId assigned to the resource.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "asyncResource",
"type": "[`EventEmitterReferencingAsyncResource`](internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
"description": "The underlying AsyncResource",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "triggerAsyncId",
"type": "`number`",
"description": "The same triggerAsyncId that is passed to the AsyncResource constructor.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](../../internal/classes/internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "triggerAsyncId",
"type": "`number`",
"description": "The same triggerAsyncId that is passed to the AsyncResource constructor.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejectionSymbol",
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/internal.Socket.mdx#capturerejectionsymbol)",
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "captureRejections",
"type": "`boolean`",
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "defaultMaxListeners",
"type": "`number`",
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "errorMonitor",
"type": "typeof [`errorMonitor`](../../internal/classes/internal.Socket.mdx#errormonitor)",
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
}
]} />
@@ -282,17 +144,7 @@ then restore the original execution context.
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "(`this`: `This`, ...`args`: `any`[]) => `Result`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "thisArg",