build(deps-dev): bump @types/node
[poolifier.git] / @types / events.d.ts
index b2da7b09329db6af2bdfde17ed08bb48c4eda45c..b5338939859c39642f667a2854d3da5ddf9b98df 100644 (file)
@@ -14,7 +14,7 @@ declare module 'events' {
     EventEmitterOptions {
     /**
      * The type of async event.
-     * @default new.target.name
+     * @default new.target.name if instantiated as a child class.
      */
     name?: string
   }
@@ -26,17 +26,21 @@ declare module 'events' {
    *
    * The EventEmitterAsyncResource class has the same methods and takes the
    * same options as EventEmitter and AsyncResource themselves.
+   * @throws if `options.name` is not provided when instantiated directly.
+   * @since v17.4.0, v16.14.0
    */
   export class EventEmitterAsyncResource extends EventEmitter {
+    /**
+     * @param options Only optional in child class.
+     */
     constructor (options?: EventEmitterAsyncResourceOptions)
     /**
      * 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.
-     * @return A reference to `asyncResource`.
      */
-    emitDestroy (): AsyncResource
+    emitDestroy (): void
     /** The unique asyncId assigned to the resource. */
     readonly asyncId: number
     /** The same triggerAsyncId that is passed to the AsyncResource constructor. */