@types/node 18.19.18 → 18.19.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- node v18.19/README.md +1 -1
- node v18.19/events.d.ts +40 -18
- node v18.19/package.json +2 -2
- node v18.19/ts4.8/events.d.ts +40 -18
node v18.19/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v18.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 27 Feb 2024 22:35:43 GMT
|
|
12
12
|
* Dependencies: [undici-types](https://npmjs.com/package/undici-types)
|
|
13
13
|
|
|
14
14
|
# Credits
|
node v18.19/events.d.ts
CHANGED
|
@@ -95,7 +95,29 @@ declare module "events" {
|
|
|
95
95
|
interface StaticEventEmitterOptions {
|
|
96
96
|
signal?: AbortSignal | undefined;
|
|
97
97
|
}
|
|
98
|
-
interface EventEmitter extends NodeJS.EventEmitter {}
|
|
98
|
+
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> extends NodeJS.EventEmitter<T> {}
|
|
99
|
+
type EventMap<T> = Record<keyof T, any[]> | DefaultEventMap;
|
|
100
|
+
type DefaultEventMap = [never];
|
|
101
|
+
const s: unique symbol;
|
|
102
|
+
type Key<K, T> = T extends DefaultEventMap ? string | symbol : K & (keyof (T & { [s]: never }));
|
|
103
|
+
type Key2<K, T> = T extends DefaultEventMap ? string | symbol : K & (keyof T);
|
|
104
|
+
type AnyRest = [...args: any[]];
|
|
105
|
+
type Args<K, T> = T extends DefaultEventMap ? AnyRest : (
|
|
106
|
+
K extends keyof T ? (
|
|
107
|
+
T[K] extends unknown[] ? T[K] : never
|
|
108
|
+
)
|
|
109
|
+
: never
|
|
110
|
+
);
|
|
111
|
+
|
|
112
|
+
type Listener<K, T, F> = T extends DefaultEventMap ? F : (
|
|
113
|
+
K extends keyof T ? (
|
|
114
|
+
T[K] extends unknown[] ? (...args: T[K]) => void : never
|
|
115
|
+
)
|
|
116
|
+
: never
|
|
117
|
+
);
|
|
118
|
+
|
|
119
|
+
type Listener1<K, T> = Listener<K, T, (...args: any[]) => void>;
|
|
120
|
+
type Listener2<K, T> = Listener<K, T, Function>;
|
|
99
121
|
/**
|
|
100
122
|
* The `EventEmitter` class is defined and exposed by the `events` module:
|
|
101
123
|
*
|
|
@@ -109,10 +131,10 @@ declare module "events" {
|
|
|
109
131
|
* It supports the following option:
|
|
110
132
|
* @since v0.1.26
|
|
111
133
|
*/
|
|
112
|
-
class EventEmitter {
|
|
134
|
+
class EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
|
113
135
|
constructor(options?: EventEmitterOptions);
|
|
114
136
|
|
|
115
|
-
[EventEmitter.captureRejectionSymbol]
|
|
137
|
+
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
|
116
138
|
|
|
117
139
|
/**
|
|
118
140
|
* Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
|
@@ -466,13 +488,13 @@ declare module "events" {
|
|
|
466
488
|
}
|
|
467
489
|
global {
|
|
468
490
|
namespace NodeJS {
|
|
469
|
-
interface EventEmitter {
|
|
470
|
-
[EventEmitter.captureRejectionSymbol]
|
|
491
|
+
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
|
492
|
+
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
|
471
493
|
/**
|
|
472
494
|
* Alias for `emitter.on(eventName, listener)`.
|
|
473
495
|
* @since v0.1.26
|
|
474
496
|
*/
|
|
475
|
-
addListener(eventName:
|
|
497
|
+
addListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
476
498
|
/**
|
|
477
499
|
* Adds the `listener` function to the end of the listeners array for the
|
|
478
500
|
* event named `eventName`. No checks are made to see if the `listener` has
|
|
@@ -503,7 +525,7 @@ declare module "events" {
|
|
|
503
525
|
* @param eventName The name of the event.
|
|
504
526
|
* @param listener The callback function
|
|
505
527
|
*/
|
|
506
|
-
on(eventName:
|
|
528
|
+
on<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
507
529
|
/**
|
|
508
530
|
* Adds a **one-time**`listener` function for the event named `eventName`. The
|
|
509
531
|
* next time `eventName` is triggered, this listener is removed and then invoked.
|
|
@@ -532,7 +554,7 @@ declare module "events" {
|
|
|
532
554
|
* @param eventName The name of the event.
|
|
533
555
|
* @param listener The callback function
|
|
534
556
|
*/
|
|
535
|
-
once(eventName:
|
|
557
|
+
once<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
536
558
|
/**
|
|
537
559
|
* Removes the specified `listener` from the listener array for the event named`eventName`.
|
|
538
560
|
*
|
|
@@ -612,12 +634,12 @@ declare module "events" {
|
|
|
612
634
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
613
635
|
* @since v0.1.26
|
|
614
636
|
*/
|
|
615
|
-
removeListener(eventName:
|
|
637
|
+
removeListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
616
638
|
/**
|
|
617
639
|
* Alias for `emitter.removeListener()`.
|
|
618
640
|
* @since v10.0.0
|
|
619
641
|
*/
|
|
620
|
-
off(eventName:
|
|
642
|
+
off<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
621
643
|
/**
|
|
622
644
|
* Removes all listeners, or those of the specified `eventName`.
|
|
623
645
|
*
|
|
@@ -628,7 +650,7 @@ declare module "events" {
|
|
|
628
650
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
629
651
|
* @since v0.1.26
|
|
630
652
|
*/
|
|
631
|
-
removeAllListeners(event?:
|
|
653
|
+
removeAllListeners(event?: Key<unknown, T>): this;
|
|
632
654
|
/**
|
|
633
655
|
* By default `EventEmitter`s will print a warning if more than `10` listeners are
|
|
634
656
|
* added for a particular event. This is a useful default that helps finding
|
|
@@ -657,7 +679,7 @@ declare module "events" {
|
|
|
657
679
|
* ```
|
|
658
680
|
* @since v0.1.26
|
|
659
681
|
*/
|
|
660
|
-
listeners(eventName:
|
|
682
|
+
listeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
|
661
683
|
/**
|
|
662
684
|
* Returns a copy of the array of listeners for the event named `eventName`,
|
|
663
685
|
* including any wrappers (such as those created by `.once()`).
|
|
@@ -687,7 +709,7 @@ declare module "events" {
|
|
|
687
709
|
* ```
|
|
688
710
|
* @since v9.4.0
|
|
689
711
|
*/
|
|
690
|
-
rawListeners(eventName:
|
|
712
|
+
rawListeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
|
691
713
|
/**
|
|
692
714
|
* Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
|
|
693
715
|
* to each.
|
|
@@ -728,7 +750,7 @@ declare module "events" {
|
|
|
728
750
|
* ```
|
|
729
751
|
* @since v0.1.26
|
|
730
752
|
*/
|
|
731
|
-
emit(eventName:
|
|
753
|
+
emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
|
|
732
754
|
/**
|
|
733
755
|
* Returns the number of listeners listening to the event named `eventName`.
|
|
734
756
|
*
|
|
@@ -738,7 +760,7 @@ declare module "events" {
|
|
|
738
760
|
* @param eventName The name of the event being listened for
|
|
739
761
|
* @param listener The event handler function
|
|
740
762
|
*/
|
|
741
|
-
listenerCount(eventName:
|
|
763
|
+
listenerCount<K>(eventName: Key<K, T>, listener?: Listener2<K, T>): number;
|
|
742
764
|
/**
|
|
743
765
|
* Adds the `listener` function to the _beginning_ of the listeners array for the
|
|
744
766
|
* event named `eventName`. No checks are made to see if the `listener` has
|
|
@@ -756,7 +778,7 @@ declare module "events" {
|
|
|
756
778
|
* @param eventName The name of the event.
|
|
757
779
|
* @param listener The callback function
|
|
758
780
|
*/
|
|
759
|
-
prependListener(eventName:
|
|
781
|
+
prependListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
760
782
|
/**
|
|
761
783
|
* 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
|
|
762
784
|
* listener is removed, and then invoked.
|
|
@@ -772,7 +794,7 @@ declare module "events" {
|
|
|
772
794
|
* @param eventName The name of the event.
|
|
773
795
|
* @param listener The callback function
|
|
774
796
|
*/
|
|
775
|
-
prependOnceListener(eventName:
|
|
797
|
+
prependOnceListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
776
798
|
/**
|
|
777
799
|
* Returns an array listing the events for which the emitter has registered
|
|
778
800
|
* listeners. The values in the array are strings or `Symbol`s.
|
|
@@ -791,7 +813,7 @@ declare module "events" {
|
|
|
791
813
|
* ```
|
|
792
814
|
* @since v6.0.0
|
|
793
815
|
*/
|
|
794
|
-
eventNames(): Array<string | symbol
|
|
816
|
+
eventNames(): Array<(string | symbol) & Key2<unknown, T>>;
|
|
795
817
|
}
|
|
796
818
|
}
|
|
797
819
|
}
|
node v18.19/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/node",
|
|
3
|
-
"version": "18.19.
|
|
3
|
+
"version": "18.19.19",
|
|
4
4
|
"description": "TypeScript definitions for node",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
|
6
6
|
"license": "MIT",
|
|
@@ -229,6 +229,6 @@
|
|
|
229
229
|
"dependencies": {
|
|
230
230
|
"undici-types": "~5.26.4"
|
|
231
231
|
},
|
|
232
|
-
"typesPublisherContentHash": "
|
|
232
|
+
"typesPublisherContentHash": "65769789b6db1a9023af674d8ee66978500868b6a6c457e0119ca97a2247cf22",
|
|
233
233
|
"typeScriptVersion": "4.6"
|
|
234
234
|
}
|
node v18.19/ts4.8/events.d.ts
CHANGED
|
@@ -95,7 +95,29 @@ declare module "events" {
|
|
|
95
95
|
interface StaticEventEmitterOptions {
|
|
96
96
|
signal?: AbortSignal | undefined;
|
|
97
97
|
}
|
|
98
|
-
interface EventEmitter extends NodeJS.EventEmitter {}
|
|
98
|
+
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> extends NodeJS.EventEmitter<T> {}
|
|
99
|
+
type EventMap<T> = Record<keyof T, any[]> | DefaultEventMap;
|
|
100
|
+
type DefaultEventMap = [never];
|
|
101
|
+
const s: unique symbol;
|
|
102
|
+
type Key<K, T> = T extends DefaultEventMap ? string | symbol : K & (keyof (T & { [s]: never }));
|
|
103
|
+
type Key2<K, T> = T extends DefaultEventMap ? string | symbol : K & (keyof T);
|
|
104
|
+
type AnyRest = [...args: any[]];
|
|
105
|
+
type Args<K, T> = T extends DefaultEventMap ? AnyRest : (
|
|
106
|
+
K extends keyof T ? (
|
|
107
|
+
T[K] extends unknown[] ? T[K] : never
|
|
108
|
+
)
|
|
109
|
+
: never
|
|
110
|
+
);
|
|
111
|
+
|
|
112
|
+
type Listener<K, T, F> = T extends DefaultEventMap ? F : (
|
|
113
|
+
K extends keyof T ? (
|
|
114
|
+
T[K] extends unknown[] ? (...args: T[K]) => void : never
|
|
115
|
+
)
|
|
116
|
+
: never
|
|
117
|
+
);
|
|
118
|
+
|
|
119
|
+
type Listener1<K, T> = Listener<K, T, (...args: any[]) => void>;
|
|
120
|
+
type Listener2<K, T> = Listener<K, T, Function>;
|
|
99
121
|
/**
|
|
100
122
|
* The `EventEmitter` class is defined and exposed by the `events` module:
|
|
101
123
|
*
|
|
@@ -109,10 +131,10 @@ declare module "events" {
|
|
|
109
131
|
* It supports the following option:
|
|
110
132
|
* @since v0.1.26
|
|
111
133
|
*/
|
|
112
|
-
class EventEmitter {
|
|
134
|
+
class EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
|
113
135
|
constructor(options?: EventEmitterOptions);
|
|
114
136
|
|
|
115
|
-
[EventEmitter.captureRejectionSymbol]
|
|
137
|
+
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
|
116
138
|
|
|
117
139
|
/**
|
|
118
140
|
* Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
|
@@ -466,13 +488,13 @@ declare module "events" {
|
|
|
466
488
|
}
|
|
467
489
|
global {
|
|
468
490
|
namespace NodeJS {
|
|
469
|
-
interface EventEmitter {
|
|
470
|
-
[EventEmitter.captureRejectionSymbol]
|
|
491
|
+
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
|
492
|
+
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
|
471
493
|
/**
|
|
472
494
|
* Alias for `emitter.on(eventName, listener)`.
|
|
473
495
|
* @since v0.1.26
|
|
474
496
|
*/
|
|
475
|
-
addListener(eventName:
|
|
497
|
+
addListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
476
498
|
/**
|
|
477
499
|
* Adds the `listener` function to the end of the listeners array for the
|
|
478
500
|
* event named `eventName`. No checks are made to see if the `listener` has
|
|
@@ -503,7 +525,7 @@ declare module "events" {
|
|
|
503
525
|
* @param eventName The name of the event.
|
|
504
526
|
* @param listener The callback function
|
|
505
527
|
*/
|
|
506
|
-
on(eventName:
|
|
528
|
+
on<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
507
529
|
/**
|
|
508
530
|
* Adds a **one-time**`listener` function for the event named `eventName`. The
|
|
509
531
|
* next time `eventName` is triggered, this listener is removed and then invoked.
|
|
@@ -532,7 +554,7 @@ declare module "events" {
|
|
|
532
554
|
* @param eventName The name of the event.
|
|
533
555
|
* @param listener The callback function
|
|
534
556
|
*/
|
|
535
|
-
once(eventName:
|
|
557
|
+
once<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
536
558
|
/**
|
|
537
559
|
* Removes the specified `listener` from the listener array for the event named`eventName`.
|
|
538
560
|
*
|
|
@@ -612,12 +634,12 @@ declare module "events" {
|
|
|
612
634
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
613
635
|
* @since v0.1.26
|
|
614
636
|
*/
|
|
615
|
-
removeListener(eventName:
|
|
637
|
+
removeListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
616
638
|
/**
|
|
617
639
|
* Alias for `emitter.removeListener()`.
|
|
618
640
|
* @since v10.0.0
|
|
619
641
|
*/
|
|
620
|
-
off(eventName:
|
|
642
|
+
off<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
621
643
|
/**
|
|
622
644
|
* Removes all listeners, or those of the specified `eventName`.
|
|
623
645
|
*
|
|
@@ -628,7 +650,7 @@ declare module "events" {
|
|
|
628
650
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
629
651
|
* @since v0.1.26
|
|
630
652
|
*/
|
|
631
|
-
removeAllListeners(event?:
|
|
653
|
+
removeAllListeners(event?: Key<unknown, T>): this;
|
|
632
654
|
/**
|
|
633
655
|
* By default `EventEmitter`s will print a warning if more than `10` listeners are
|
|
634
656
|
* added for a particular event. This is a useful default that helps finding
|
|
@@ -657,7 +679,7 @@ declare module "events" {
|
|
|
657
679
|
* ```
|
|
658
680
|
* @since v0.1.26
|
|
659
681
|
*/
|
|
660
|
-
listeners(eventName:
|
|
682
|
+
listeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
|
661
683
|
/**
|
|
662
684
|
* Returns a copy of the array of listeners for the event named `eventName`,
|
|
663
685
|
* including any wrappers (such as those created by `.once()`).
|
|
@@ -687,7 +709,7 @@ declare module "events" {
|
|
|
687
709
|
* ```
|
|
688
710
|
* @since v9.4.0
|
|
689
711
|
*/
|
|
690
|
-
rawListeners(eventName:
|
|
712
|
+
rawListeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
|
691
713
|
/**
|
|
692
714
|
* Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
|
|
693
715
|
* to each.
|
|
@@ -728,7 +750,7 @@ declare module "events" {
|
|
|
728
750
|
* ```
|
|
729
751
|
* @since v0.1.26
|
|
730
752
|
*/
|
|
731
|
-
emit(eventName:
|
|
753
|
+
emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
|
|
732
754
|
/**
|
|
733
755
|
* Returns the number of listeners listening to the event named `eventName`.
|
|
734
756
|
*
|
|
@@ -738,7 +760,7 @@ declare module "events" {
|
|
|
738
760
|
* @param eventName The name of the event being listened for
|
|
739
761
|
* @param listener The event handler function
|
|
740
762
|
*/
|
|
741
|
-
listenerCount(eventName:
|
|
763
|
+
listenerCount<K>(eventName: Key<K, T>, listener?: Listener2<K, T>): number;
|
|
742
764
|
/**
|
|
743
765
|
* Adds the `listener` function to the _beginning_ of the listeners array for the
|
|
744
766
|
* event named `eventName`. No checks are made to see if the `listener` has
|
|
@@ -756,7 +778,7 @@ declare module "events" {
|
|
|
756
778
|
* @param eventName The name of the event.
|
|
757
779
|
* @param listener The callback function
|
|
758
780
|
*/
|
|
759
|
-
prependListener(eventName:
|
|
781
|
+
prependListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
760
782
|
/**
|
|
761
783
|
* 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
|
|
762
784
|
* listener is removed, and then invoked.
|
|
@@ -772,7 +794,7 @@ declare module "events" {
|
|
|
772
794
|
* @param eventName The name of the event.
|
|
773
795
|
* @param listener The callback function
|
|
774
796
|
*/
|
|
775
|
-
prependOnceListener(eventName:
|
|
797
|
+
prependOnceListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
|
776
798
|
/**
|
|
777
799
|
* Returns an array listing the events for which the emitter has registered
|
|
778
800
|
* listeners. The values in the array are strings or `Symbol`s.
|
|
@@ -791,7 +813,7 @@ declare module "events" {
|
|
|
791
813
|
* ```
|
|
792
814
|
* @since v6.0.0
|
|
793
815
|
*/
|
|
794
|
-
eventNames(): Array<string | symbol
|
|
816
|
+
eventNames(): Array<(string | symbol) & Key2<unknown, T>>;
|
|
795
817
|
}
|
|
796
818
|
}
|
|
797
819
|
}
|