Server
[<Interface>]
type Server<'Request, 'Response when 'Request :> IncomingMessageConstructor> =
abstract member EventEmitter: EventEmitterConstructor with get, set
abstract member EventEmitterAsyncResource: EventEmitterAsyncResourceConstructor with get, set
abstract member captureRejectionSymbol: Symbol
abstract member captureRejections: bool with get, set
abstract member defaultMaxListeners: float with get, set
abstract member errorMonitor: Symbol
static member addAbortListener (signal: AbortSignal, resource: Event -> unit) : Disposable
abstract member addListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member addListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member addListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member addListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member addListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member addListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member addListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member addListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member addListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member addListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member addListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member addListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member addListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member addListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member close (?callback: (exn option -> unit)) : Server<'Request,'Response>
abstract member emitCheckContinue (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitCheckExpectation (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitConnection (socket: Duplex) : bool
abstract member emitOCSPRequest (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: Callback) : bool
abstract member emitRequest (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitResumeSession (sessionId: NonSharedBuffer, callback: Callback2) : bool
abstract member getConnections (cb: Cb) : Server<'Request,'Response>
static member getEventListeners (emitter: U2<EventEmitter<unit array>,EventTarget>, name: U2<string,Symbol>) : Function array
static member getMaxListeners (emitter: U2<EventEmitter<unit array>,EventTarget>) : float
abstract member listen (handle: obj, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (handle: obj, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (options: ListenOptions, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (path: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (path: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?hostname: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?hostname: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
static member listenerCount (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>) : float
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>
static member on (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
static member on (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
abstract member on (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member onCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onClientError (listener: Listener6) : Server<'Request,'Response>
abstract member onClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member onConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member onConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member onError (listener: exn -> unit) : Server<'Request,'Response>
abstract member onKeylog (listener: Listener) : Server<'Request,'Response>
abstract member onListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member onNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member onOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member onRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member onSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member onTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member onUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
static member once (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterOptions) : Promise<obj array>
static member once (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterOptions) : Promise<obj array>
abstract member once (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member onceCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceClientError (listener: Listener6) : Server<'Request,'Response>
abstract member onceClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member onceConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member onceConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member onceError (listener: exn -> unit) : Server<'Request,'Response>
abstract member onceKeylog (listener: Listener) : Server<'Request,'Response>
abstract member onceListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member onceNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member onceOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member onceRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member onceSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member onceTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member onceUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member prependListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member prependListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member prependListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member prependListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member prependListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member prependListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member prependListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member prependListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member prependListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member prependListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member prependListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member prependListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member prependOnceListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member prependOnceListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member prependOnceListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member prependOnceListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member prependOnceListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member prependOnceListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member prependOnceListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member prependOnceListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member ref () : Server<'Request,'Response>
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Server<'Request,'Response>
abstract member removeListener (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>
static member setMaxListeners (n: float option, eventTargets: U2<EventEmitter<unit array>,EventTarget> array) : unit
abstract member setMaxListeners (n: float) : Server<'Request,'Response>
abstract member setTimeout (callback: Socket -> unit) : Server<'Request,'Response>
abstract member setTimeout (?msecs: float, ?callback: (Socket -> unit)) : Server<'Request,'Response>
abstract member unref () : Server<'Request,'Response>| Assembly | Xantham.Fable.Node |
| Implements | Server<'Request,'Response>, Server |
| Attributes | [<Interface>] [<Import>] |
See http.Server for more information.
@since v0.3.4
Declared inside
AddListener | |
Emit | |
On | |
Once | |
PrependListener | |
PrependOnceListener |
Properties
abstract member EventEmitter: EventEmitterConstructor with get, setabstract member EventEmitterAsyncResource: EventEmitterAsyncResourceConstructor with get, set
abstract member EventEmitterAsyncResource: EventEmitterAsyncResourceConstructor with get, setIntegrates EventEmitter with AsyncResource for EventEmitters that require manual async tracking. Specifically, all events emitted by instances of events.EventEmitterAsyncResource will run within its async context.
import { EventEmitterAsyncResource, EventEmitter } from 'node:events';
import { notStrictEqual, strictEqual } from 'node:assert';
import { executionAsyncId, triggerAsyncId } from 'node:async_hooks';
// Async tracking tooling will identify this as 'Q'.
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });
// 'foo' listeners will run in the EventEmitters async context.
ee1.on('foo', () => {
strictEqual(executionAsyncId(), ee1.asyncId);
strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});
const ee2 = new EventEmitter();
// 'foo' listeners on ordinary EventEmitters that do not track async
// context, however, run in the same async context as the emit().
ee2.on('foo', () => {
notStrictEqual(executionAsyncId(), ee2.asyncId);
notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});
Promise.resolve().then(() => {
ee1.emit('foo');
ee2.emit('foo');
});
The EventEmitterAsyncResource class has the same methods and takes the same options as EventEmitter and AsyncResource themselves.
@since v17.4.0, v16.14.0
abstract member captureRejectionSymbol: Symbol
abstract member captureRejectionSymbol: SymbolValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
@since v13.4.0, v12.16.0
abstract member captureRejections: bool with get, set
abstract member captureRejections: bool with get, setValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
@since v13.4.0, v12.16.0
abstract member defaultMaxListeners: float with get, set
abstract member defaultMaxListeners: float with get, setBy 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 allEventEmitter 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:
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'.
@since v0.11.2
abstract member errorMonitor: Symbol
abstract member errorMonitor: SymbolThis 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.
@since v13.6.0, v12.17.0
Methods
static member addAbortListener (signal: AbortSignal, resource: Event -> unit) : Disposable
static member addAbortListener (signal: AbortSignal, resource: Event -> unit) : DisposableListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.
This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.
Returns a disposable so that it may be unsubscribed from more easily.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
@since v20.5.0
Returns. Disposable that removes the abort listener.
abstract member addListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member addListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>events.EventEmitter
- tlsClientError
- newSession
- OCSPRequest
- resumeSession
- secureConnection
- keylog
abstract member addListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>addListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this
abstract member addListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>addListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this
abstract member addListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member addListenerClientError (listener: Listener6) : Server<'Request,'Response>addListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this
abstract member addListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member addListenerClose (listener: unit -> unit) : Server<'Request,'Response>addListener(event: "close", listener: () => void): this
abstract member addListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member addListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>addListener(event: "connect", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member addListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member addListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>addListener(event: "connection", listener: (socket: Duplex) => void): this
abstract member addListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member addListenerError (listener: exn -> unit) : Server<'Request,'Response>addListener(event: "error", listener: (err: Error) => void): this
abstract member addListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member addListenerKeylog (listener: Listener) : Server<'Request,'Response>addListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this
abstract member addListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member addListenerListening (listener: unit -> unit) : Server<'Request,'Response>addListener(event: "listening", listener: () => void): this
abstract member addListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member addListenerNewSession (listener: Listener2) : Server<'Request,'Response>addListener(event: "newSession", listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void): this
abstract member addListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member addListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>addListener(event: "OCSPRequest", listener: (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void) => void): this
abstract member addListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member addListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>addListener(event: "request", listener: http.RequestListener<Request, Response>): this
abstract member addListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member addListenerResumeSession (listener: Listener4) : Server<'Request,'Response>addListener(event: "resumeSession", listener: (sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this
abstract member addListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member addListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>addListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this
abstract member addListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member addListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this
abstract member addListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member addListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>addListener(event: "upgrade", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member close (?callback: (exn option -> unit)) : Server<'Request,'Response>
abstract member close (?callback: (exn option -> unit)) : Server<'Request,'Response>Stops the server from accepting new connections and keeps existing connections. This function is asynchronous, the server is finally closed when all connections are ended and the server emits a 'close' event. The optional callback will be called once the 'close' event occurs. Unlike that event, it will be called with an Error as its only argument if the server was not open when it was closed.
@since v0.1.90
| Parameter | |
|---|---|
callback | Called when the server is closed. |
abstract member emitCheckContinue (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitCheckContinue (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : boolemit(event: "checkContinue", req: InstanceType<Request>, res: InstanceType<Response>): boolean
abstract member emitCheckExpectation (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitCheckExpectation (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : boolemit(event: "checkExpectation", req: InstanceType<Request>, res: InstanceType<Response>): boolean
abstract member emitConnection (socket: Duplex) : bool
abstract member emitConnection (socket: Duplex) : boolemit(event: "connection", socket: Duplex): boolean
abstract member emitOCSPRequest (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: Callback) : bool
abstract member emitOCSPRequest (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: Callback) : boolemit(event: "OCSPRequest", certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void): boolean
abstract member emitRequest (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : bool
abstract member emitRequest (req: IncomingMessage, res: ServerResponse<IncomingMessage>) : boolemit(event: "request", req: InstanceType<Request>, res: InstanceType<Response>): boolean
abstract member emitResumeSession (sessionId: NonSharedBuffer, callback: Callback2) : bool
abstract member emitResumeSession (sessionId: NonSharedBuffer, callback: Callback2) : boolemit(event: "resumeSession", sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void): boolean
abstract member getConnections (cb: Cb) : Server<'Request,'Response>
abstract member getConnections (cb: Cb) : Server<'Request,'Response>Asynchronously get the number of concurrent connections on the server. Works when sockets were sent to forks.
Callback should take two arguments err and count.
@since v0.9.7
static member getEventListeners (emitter: U2<EventEmitter<unit array>,EventTarget>, name: U2<string,Symbol>) : Function array
static member getEventListeners (emitter: U2<EventEmitter<unit array>,EventTarget>, name: U2<string,Symbol>) : Function arrayReturns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on the emitter.
For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
@since v15.2.0, v14.17.0
static member getMaxListeners (emitter: U2<EventEmitter<unit array>,EventTarget>) : float
static member getMaxListeners (emitter: U2<EventEmitter<unit array>,EventTarget>) : floatReturns the currently set max amount of listeners.
For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.
For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
@since v19.9.0
abstract member listen (handle: obj, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (handle: obj, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (handle: obj, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (handle: obj, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (options: ListenOptions, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (options: ListenOptions, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (path: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (path: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (path: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (path: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (?port: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (?port: float, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (?port: float, ?hostname: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?hostname: string, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
abstract member listen (?port: float, ?hostname: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>
abstract member listen (?port: float, ?hostname: string, ?backlog: float, ?listeningListener: (unit -> unit)) : Server<'Request,'Response>Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.
Possible signatures:
server.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])forIPCserversserver.listen([port[, host[, backlog]]][, callback])for TCP servers
This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).
All Socket are set to SO_REUSEADDR (see socket(7) for details).
The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.
One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:
server.on('error', (e) => {
if (e.code === 'EADDRINUSE') {
console.error('Address in use, retrying...');
setTimeout(() => {
server.close();
server.listen(PORT, HOST);
}, 1000);
}
});
static member listenerCount (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>) : float
static member listenerCount (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>) : floatA class method that returns the number of listeners for the given eventName registered on the given emitter.
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
@since v0.9.12
| Parameter | |
|---|---|
emitter | The emitter to query |
eventName | The event name |
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>Alias for emitter.removeListener().
@since v10.0.0
static member on (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
static member on (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.
An AbortSignal can be used to cancel waiting on events:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
Use the close option to specify an array of event names that will end the iteration:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'
@since v13.6.0, v12.16.0
Returns. An AsyncIterator that iterates eventName events emitted by the emitter
static member on (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>
static member on (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterIteratorOptions) : AsyncIterator<obj array,obj,obj>import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.
An AbortSignal can be used to cancel waiting on events:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
Use the close option to specify an array of event names that will end the iteration:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'
@since v13.6.0, v12.16.0
Returns. An AsyncIterator that iterates eventName events emitted by the emitter
abstract member on (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member on (event: string, listener: obj array -> unit) : Server<'Request,'Response>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 already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
abstract member onCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>on(event: "checkContinue", listener: http.RequestListener<Request, Response>): this
abstract member onCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>on(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this
abstract member onClientError (listener: Listener6) : Server<'Request,'Response>
abstract member onClientError (listener: Listener6) : Server<'Request,'Response>on(event: "clientError", listener: (err: Error, socket: Duplex) => void): this
abstract member onClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member onClose (listener: unit -> unit) : Server<'Request,'Response>on(event: "close", listener: () => void): this
abstract member onConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member onConnect (listener: Listener7<'Request>) : Server<'Request,'Response>on(event: "connect", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member onConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member onConnection (listener: Duplex -> unit) : Server<'Request,'Response>on(event: "connection", listener: (socket: Duplex) => void): this
abstract member onError (listener: exn -> unit) : Server<'Request,'Response>
abstract member onError (listener: exn -> unit) : Server<'Request,'Response>on(event: "error", listener: (err: Error) => void): this
abstract member onKeylog (listener: Listener) : Server<'Request,'Response>
abstract member onKeylog (listener: Listener) : Server<'Request,'Response>on(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this
abstract member onListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member onListening (listener: unit -> unit) : Server<'Request,'Response>on(event: "listening", listener: () => void): this
abstract member onNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member onNewSession (listener: Listener2) : Server<'Request,'Response>on(event: "newSession", listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void): this
abstract member onOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member onOCSPRequest (listener: Listener3) : Server<'Request,'Response>on(event: "OCSPRequest", listener: (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void) => void): this
abstract member onRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>on(event: "request", listener: http.RequestListener<Request, Response>): this
abstract member onResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member onResumeSession (listener: Listener4) : Server<'Request,'Response>on(event: "resumeSession", listener: (sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this
abstract member onSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member onSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>on(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this
abstract member onTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member onTlsClientError (listener: Listener5) : Server<'Request,'Response>on(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this
abstract member onUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member onUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>on(event: "upgrade", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
static member once (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterOptions) : Promise<obj array>
static member once (emitter: EventTarget, eventName: string, ?options: StaticEventEmitterOptions) : Promise<obj array>Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.
This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}
The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
An AbortSignal can be used to cancel waiting for the event:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
@since v11.13.0, v10.16.0
static member once (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterOptions) : Promise<obj array>
static member once (emitter: EventEmitter<unit array>, eventName: U2<string,Symbol>, ?options: StaticEventEmitterOptions) : Promise<obj array>Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.
This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}
The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
An AbortSignal can be used to cancel waiting for the event:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
@since v11.13.0, v10.16.0
abstract member once (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member once (event: string, listener: obj array -> unit) : Server<'Request,'Response>Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
abstract member onceCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>once(event: "checkContinue", listener: http.RequestListener<Request, Response>): this
abstract member onceCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>once(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this
abstract member onceClientError (listener: Listener6) : Server<'Request,'Response>
abstract member onceClientError (listener: Listener6) : Server<'Request,'Response>once(event: "clientError", listener: (err: Error, socket: Duplex) => void): this
abstract member onceClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member onceClose (listener: unit -> unit) : Server<'Request,'Response>once(event: "close", listener: () => void): this
abstract member onceConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member onceConnect (listener: Listener7<'Request>) : Server<'Request,'Response>once(event: "connect", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member onceConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member onceConnection (listener: Duplex -> unit) : Server<'Request,'Response>once(event: "connection", listener: (socket: Duplex) => void): this
abstract member onceError (listener: exn -> unit) : Server<'Request,'Response>
abstract member onceError (listener: exn -> unit) : Server<'Request,'Response>once(event: "error", listener: (err: Error) => void): this
abstract member onceKeylog (listener: Listener) : Server<'Request,'Response>
abstract member onceKeylog (listener: Listener) : Server<'Request,'Response>once(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this
abstract member onceListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member onceListening (listener: unit -> unit) : Server<'Request,'Response>once(event: "listening", listener: () => void): this
abstract member onceNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member onceNewSession (listener: Listener2) : Server<'Request,'Response>once(event: "newSession", listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void): this
abstract member onceOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member onceOCSPRequest (listener: Listener3) : Server<'Request,'Response>once(event: "OCSPRequest", listener: (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void) => void): this
abstract member onceRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member onceRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>once(event: "request", listener: http.RequestListener<Request, Response>): this
abstract member onceResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member onceResumeSession (listener: Listener4) : Server<'Request,'Response>once(event: "resumeSession", listener: (sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this
abstract member onceSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member onceSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>once(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this
abstract member onceTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member onceTlsClientError (listener: Listener5) : Server<'Request,'Response>once(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this
abstract member onceUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member onceUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>once(event: "upgrade", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member prependListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member prependListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>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 already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
abstract member prependListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this
abstract member prependListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this
abstract member prependListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member prependListenerClientError (listener: Listener6) : Server<'Request,'Response>prependListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this
abstract member prependListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependListenerClose (listener: unit -> unit) : Server<'Request,'Response>prependListener(event: "close", listener: () => void): this
abstract member prependListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member prependListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>prependListener(event: "connect", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member prependListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member prependListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>prependListener(event: "connection", listener: (socket: Duplex) => void): this
abstract member prependListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member prependListenerError (listener: exn -> unit) : Server<'Request,'Response>prependListener(event: "error", listener: (err: Error) => void): this
abstract member prependListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member prependListenerKeylog (listener: Listener) : Server<'Request,'Response>prependListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this
abstract member prependListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependListenerListening (listener: unit -> unit) : Server<'Request,'Response>prependListener(event: "listening", listener: () => void): this
abstract member prependListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member prependListenerNewSession (listener: Listener2) : Server<'Request,'Response>prependListener(event: "newSession", listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void): this
abstract member prependListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member prependListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>prependListener(event: "OCSPRequest", listener: (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void) => void): this
abstract member prependListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependListener(event: "request", listener: http.RequestListener<Request, Response>): this
abstract member prependListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member prependListenerResumeSession (listener: Listener4) : Server<'Request,'Response>prependListener(event: "resumeSession", listener: (sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this
abstract member prependListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member prependListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>prependListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this
abstract member prependListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member prependListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this
abstract member prependListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member prependListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>prependListener(event: "upgrade", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member prependOnceListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>
abstract member prependOnceListener (event: string, listener: obj array -> unit) : Server<'Request,'Response>Adds a one-timelistener 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.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
abstract member prependOnceListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerCheckContinue (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependOnceListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this
abstract member prependOnceListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerCheckExpectation (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependOnceListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this
abstract member prependOnceListenerClientError (listener: Listener6) : Server<'Request,'Response>
abstract member prependOnceListenerClientError (listener: Listener6) : Server<'Request,'Response>prependOnceListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this
abstract member prependOnceListenerClose (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerClose (listener: unit -> unit) : Server<'Request,'Response>prependOnceListener(event: "close", listener: () => void): this
abstract member prependOnceListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>
abstract member prependOnceListenerConnect (listener: Listener7<'Request>) : Server<'Request,'Response>prependOnceListener(event: "connect", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member prependOnceListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerConnection (listener: Duplex -> unit) : Server<'Request,'Response>prependOnceListener(event: "connection", listener: (socket: Duplex) => void): this
abstract member prependOnceListenerError (listener: exn -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerError (listener: exn -> unit) : Server<'Request,'Response>prependOnceListener(event: "error", listener: (err: Error) => void): this
abstract member prependOnceListenerKeylog (listener: Listener) : Server<'Request,'Response>
abstract member prependOnceListenerKeylog (listener: Listener) : Server<'Request,'Response>prependOnceListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this
abstract member prependOnceListenerListening (listener: unit -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerListening (listener: unit -> unit) : Server<'Request,'Response>prependOnceListener(event: "listening", listener: () => void): this
abstract member prependOnceListenerNewSession (listener: Listener2) : Server<'Request,'Response>
abstract member prependOnceListenerNewSession (listener: Listener2) : Server<'Request,'Response>prependOnceListener(event: "newSession", listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void): this
abstract member prependOnceListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>
abstract member prependOnceListenerOCSPRequest (listener: Listener3) : Server<'Request,'Response>prependOnceListener(event: "OCSPRequest", listener: (certificate: NonSharedBuffer, issuer: NonSharedBuffer, callback: (err: Error | null, resp: Buffer | null) => void) => void): this
abstract member prependOnceListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>
abstract member prependOnceListenerRequest (listener: Action<IncomingMessage,obj>) : Server<'Request,'Response>prependOnceListener(event: "request", listener: http.RequestListener<Request, Response>): this
abstract member prependOnceListenerResumeSession (listener: Listener4) : Server<'Request,'Response>
abstract member prependOnceListenerResumeSession (listener: Listener4) : Server<'Request,'Response>prependOnceListener(event: "resumeSession", listener: (sessionId: NonSharedBuffer, callback: (err: Error | null, sessionData: Buffer | null) => void) => void): this
abstract member prependOnceListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>
abstract member prependOnceListenerSecureConnection (listener: TLSSocket -> unit) : Server<'Request,'Response>prependOnceListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this
abstract member prependOnceListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>
abstract member prependOnceListenerTlsClientError (listener: Listener5) : Server<'Request,'Response>prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this
abstract member prependOnceListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>
abstract member prependOnceListenerUpgrade (listener: Listener8<'Request>) : Server<'Request,'Response>prependOnceListener(event: "upgrade", listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void): this
abstract member ref () : Server<'Request,'Response>
abstract member ref () : Server<'Request,'Response>Opposite of unref(), calling ref() on a previously unrefed server will not let the program exit if it's the only server left (the default behavior). If the server is refed calling ref() again will have no effect.
@since v0.9.1
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Server<'Request,'Response>
abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Server<'Request,'Response>Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
@since v0.1.26
abstract member removeListener (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>
abstract member removeListener (eventName: U2<string,Symbol>, listener: obj array -> unit) : Server<'Request,'Response>Removes the specified listener from the listener array for the event named eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
@since v0.1.26
static member setMaxListeners (n: float option, eventTargets: U2<EventEmitter<unit array>,EventTarget> array) : unit
static member setMaxListeners (n: float option, eventTargets: U2<EventEmitter<unit array>,EventTarget> array) : unitimport { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
@since v15.4.0
| Parameter | |
|---|---|
n | A non-negative number. The maximum number of listeners per EventTarget event. |
eventTargets | Zero or more or instances. If none are specified, n is set as the default max for all newly created and objects. |
abstract member setMaxListeners (n: float) : Server<'Request,'Response>
abstract member setMaxListeners (n: float) : Server<'Request,'Response>By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
@since v0.3.5
abstract member setTimeout (callback: Socket -> unit) : Server<'Request,'Response>
abstract member setTimeout (callback: Socket -> unit) : Server<'Request,'Response>Sets the timeout value for sockets, and emits a 'timeout' event on the Server object, passing the socket as an argument, if a timeout occurs.
If there is a 'timeout' event listener on the Server object, then it will be called with the timed-out socket as an argument.
By default, the Server does not timeout sockets. However, if a callback is assigned to the Server's 'timeout' event, timeouts must be handled explicitly.
@since v0.9.12
abstract member setTimeout (?msecs: float, ?callback: (Socket -> unit)) : Server<'Request,'Response>
abstract member setTimeout (?msecs: float, ?callback: (Socket -> unit)) : Server<'Request,'Response>Sets the timeout value for sockets, and emits a 'timeout' event on the Server object, passing the socket as an argument, if a timeout occurs.
If there is a 'timeout' event listener on the Server object, then it will be called with the timed-out socket as an argument.
By default, the Server does not timeout sockets. However, if a callback is assigned to the Server's 'timeout' event, timeouts must be handled explicitly.
@since v0.9.12