Class: ApiResponse<Request>

@sapphire/plugin-api.ApiResponse

Since

1.0.0

Type parameters

Name	Type
Request	extends IncomingMessage = IncomingMessage

Hierarchy

• ServerResponse<Request>

  ↳ ApiResponse

Constructors

constructor

• new ApiResponse<Request>(req): ApiResponse<Request>

Type parameters

Name	Type
Request	extends IncomingMessage = IncomingMessage

Parameters

Name	Type
req	Request

Returns

ApiResponse<Request>

Inherited from

ServerResponse<Request>.constructor

Defined in

node_modules/@types/node/http.d.ts:741

Properties

chunkedEncoding

• chunkedEncoding: boolean

Inherited from

ServerResponse.chunkedEncoding

Defined in

node_modules/@types/node/http.d.ts:549

---

closed

• Readonly closed: boolean

Is true after 'close' has been emitted.

Since

v18.0.0

Inherited from

ServerResponse.closed

Defined in

node_modules/@types/node/stream.d.ts:704

---

connection

• Readonly connection: null | Socket

Alias of outgoingMessage.socket.

Since

v0.3.0

Deprecated

Since v15.12.0,v14.17.1 - Use socket instead.

Inherited from

ServerResponse.connection

Defined in

node_modules/@types/node/http.d.ts:567

---

cookies

• cookies: CookieStore

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:15

---

destroyed

• destroyed: boolean

Is true after writable.destroy() has been called.

Since

v8.0.0

Inherited from

ServerResponse.destroyed

Defined in

node_modules/@types/node/stream.d.ts:699

---

errored

• Readonly errored: null | Error

Returns error if the stream has been destroyed with an error.

Since

v18.0.0

Inherited from

ServerResponse.errored

Defined in

node_modules/@types/node/stream.d.ts:709

---

finished

• finished: boolean

Deprecated

Use writableEnded instead.

Inherited from

ServerResponse.finished

Defined in

node_modules/@types/node/http.d.ts:556

---

headersSent

• Readonly headersSent: boolean

Read-only. true if the headers were sent, otherwise false.

Since

v0.9.3

Inherited from

ServerResponse.headersSent

Defined in

node_modules/@types/node/http.d.ts:561

---

req

• Readonly req: Request

Inherited from

ServerResponse.req

Defined in

node_modules/@types/node/http.d.ts:548

---

sendDate

• sendDate: boolean

Inherited from

ServerResponse.sendDate

Defined in

node_modules/@types/node/http.d.ts:552

---

shouldKeepAlive

• shouldKeepAlive: boolean

Inherited from

ServerResponse.shouldKeepAlive

Defined in

node_modules/@types/node/http.d.ts:550

---

socket

• Readonly socket: null | Socket

Reference to the underlying socket. Usually, users will not want to access this property.

After calling outgoingMessage.end(), this property will be nulled.

Since

v0.3.0

Inherited from

ServerResponse.socket

Defined in

node_modules/@types/node/http.d.ts:575

---

statusCode

• statusCode: number

When using implicit headers (not calling response.writeHead() explicitly), this property controls the status code that will be sent to the client when the headers get flushed.

response.statusCode = 404;

After response header was sent to the client, this property indicates the status code which was sent out.

Since

v0.4.0

Inherited from

ServerResponse.statusCode

Defined in

node_modules/@types/node/http.d.ts:718

---

statusMessage

• statusMessage: string

When using implicit headers (not calling response.writeHead() explicitly), this property controls the status message that will be sent to the client when the headers get flushed. If this is left as undefined then the standard message for the status code will be used.

response.statusMessage = 'Not found';

After response header was sent to the client, this property indicates the status message which was sent out.

Since

v0.11.8

Inherited from

ServerResponse.statusMessage

Defined in

node_modules/@types/node/http.d.ts:733

---

strictContentLength

• strictContentLength: boolean

If set to true, Node.js will check whether the Content-Lengthheader value and the size of the body, in bytes, are equal. Mismatching the Content-Length header value will result in an Error being thrown, identified by code:``'ERR_HTTP_CONTENT_LENGTH_MISMATCH'.

Since

v18.10.0, v16.18.0

Inherited from

ServerResponse.strictContentLength

Defined in

node_modules/@types/node/http.d.ts:740

---

useChunkedEncodingByDefault

• useChunkedEncodingByDefault: boolean

Inherited from

ServerResponse.useChunkedEncodingByDefault

Defined in

node_modules/@types/node/http.d.ts:551

---

writable

• Readonly writable: boolean

Is true if it is safe to call writable.write(), which means the stream has not been destroyed, errored, or ended.

Since

v11.4.0

Inherited from

ServerResponse.writable

Defined in

node_modules/@types/node/stream.d.ts:660

---

writableCorked

• Readonly writableCorked: number

Number of times writable.uncork() needs to be called in order to fully uncork the stream.

Since

v13.2.0, v12.16.0

Inherited from

ServerResponse.writableCorked

Defined in

node_modules/@types/node/stream.d.ts:694

---

writableEnded

• Readonly writableEnded: boolean

Is true after writable.end() has been called. This property does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

Since

v12.9.0

Inherited from

ServerResponse.writableEnded

Defined in

node_modules/@types/node/stream.d.ts:666

---

writableFinished

• Readonly writableFinished: boolean

Is set to true immediately before the 'finish' event is emitted.

Since

v12.6.0

Inherited from

ServerResponse.writableFinished

Defined in

node_modules/@types/node/stream.d.ts:671

---

writableHighWaterMark

• Readonly writableHighWaterMark: number

Return the value of highWaterMark passed when creating this Writable.

Since

v9.3.0

Inherited from

ServerResponse.writableHighWaterMark

Defined in

node_modules/@types/node/stream.d.ts:676

---

writableLength

• Readonly writableLength: number

This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the highWaterMark.

Since

v9.4.0

Inherited from

ServerResponse.writableLength

Defined in

node_modules/@types/node/stream.d.ts:683

---

writableNeedDrain

• Readonly writableNeedDrain: boolean

Is true if the stream's buffer has been full and stream will emit 'drain'.

Since

v15.2.0, v14.17.0

Inherited from

ServerResponse.writableNeedDrain

Defined in

node_modules/@types/node/stream.d.ts:714

---

writableObjectMode

• Readonly writableObjectMode: boolean

Getter for the property objectMode of a given Writable stream.

Since

v12.3.0

Inherited from

ServerResponse.writableObjectMode

Defined in

node_modules/@types/node/stream.d.ts:688

---

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Inherited from

ServerResponse.captureRejectionSymbol

Defined in

node_modules/@types/node/events.d.ts:415

---

captureRejections

▪ Static captureRejections: boolean

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Inherited from

ServerResponse.captureRejections

Defined in

node_modules/@types/node/events.d.ts:422

---

defaultMaxListeners

▪ Static defaultMaxListeners: number

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

Take caution when setting the events.defaultMaxListeners because the change affects allEventEmitter 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 singleEventEmitter, 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

Inherited from

ServerResponse.defaultMaxListeners

Defined in

node_modules/@types/node/events.d.ts:459

---

errorMonitor

▪ Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Inherited from

ServerResponse.errorMonitor

Defined in

node_modules/@types/node/events.d.ts:408

Methods

[captureRejectionSymbol]

▸ [captureRejectionSymbol]<K>(error, event, ...args): void

Type parameters

Name
K

Parameters

Name	Type
error	Error
event	string | symbol
...args	AnyRest

Returns

void

Inherited from

ServerResponse.[captureRejectionSymbol]

Defined in

node_modules/@types/node/events.d.ts:125

---

_construct

▸ _construct(callback): void

Parameters

Name	Type
callback	(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._construct

Defined in

node_modules/@types/node/stream.d.ts:724

---

_destroy

▸ _destroy(error, callback): void

Parameters

Name	Type
error	null | Error
callback	(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._destroy

Defined in

node_modules/@types/node/stream.d.ts:725

---

_final

▸ _final(callback): void

Parameters

Name	Type
callback	(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._final

Defined in

node_modules/@types/node/stream.d.ts:726

---

_write

▸ _write(chunk, encoding, callback): void

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
callback	(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._write

Defined in

node_modules/@types/node/stream.d.ts:716

---

_writev

▸ _writev(chunks, callback): void

Parameters

Name	Type
chunks	{ chunk: any ; encoding: BufferEncoding }[]
callback	(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._writev

Defined in

node_modules/@types/node/stream.d.ts:717

---

addListener

▸ addListener(event, listener): this

Event emitter The defined events on documents including:

1. close
2. drain
3. error
4. finish
5. pipe
6. unpipe

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:892

▸ addListener(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:893

▸ addListener(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:894

▸ addListener(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:895

▸ addListener(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:896

▸ addListener(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:897

▸ addListener(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.addListener

Defined in

node_modules/@types/node/stream.d.ts:898

---

addTrailers

▸ addTrailers(headers): void

Adds HTTP trailers (headers but at the end of the message) to the message.

Trailers will only be emitted if the message is chunked encoded. If not, the trailers will be silently discarded.

HTTP requires the Trailer header to be sent to emit trailers, with a list of header field names in its value, e.g.

message.writeHead(200, { 'Content-Type': 'text/plain',
                         'Trailer': 'Content-MD5' });
message.write(fileData);
message.addTrailers({ 'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667' });
message.end();

Attempting to set a header field name or value that contains invalid characters will result in a TypeError being thrown.

Parameters

Name	Type
headers	OutgoingHttpHeaders | readonly [string, string][]

Returns

void

Since

v0.3.0

Inherited from

ServerResponse.addTrailers

Defined in

node_modules/@types/node/http.d.ts:684

---

appendHeader

▸ appendHeader(name, value): this

Append a single header value for the header object.

If the value is an array, this is equivalent of calling this method multiple times.

If there were no previous value for the header, this is equivalent of calling outgoingMessage.setHeader(name, value).

Depending of the value of options.uniqueHeaders when the client request or the server were created, this will end up in the header being sent multiple times or a single time with values joined using ; .

Parameters

Name	Type	Description
name	string	Header name
value	string | readonly string[]	Header value

Returns

this

Since

v18.3.0, v16.17.0

Inherited from

ServerResponse.appendHeader

Defined in

node_modules/@types/node/http.d.ts:607

---

assignSocket

▸ assignSocket(socket): void

Parameters

Name	Type
socket	Socket

Returns

void

Inherited from

ServerResponse.assignSocket

Defined in

node_modules/@types/node/http.d.ts:742

---

badRequest

▸ badRequest(data?): void

Parameters

Name	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:44

---

compose

▸ compose<T>(stream, options?): T

Type parameters

Name	Type
T	extends ReadableStream

Parameters

Name	Type
stream	ComposeFnParam | T | Iterable<T> | AsyncIterable<T>
options?	Object
options.signal	AbortSignal

Returns

T

Inherited from

ServerResponse.compose

Defined in

node_modules/@types/node/stream.d.ts:35

---

conflict

▸ conflict(data?): void

Parameters

Name	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:72

---

cork

▸ cork(): void

The writable.cork() method forces all written data to be buffered in memory. The buffered data will be flushed when either the uncork or end methods are called.

The primary intent of writable.cork() is to accommodate a situation in which several small chunks are written to the stream in rapid succession. Instead of immediately forwarding them to the underlying destination, writable.cork()buffers all the chunks until writable.uncork() is called, which will pass them all to writable._writev(), if present. This prevents a head-of-line blocking situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementingwritable._writev() may have an adverse effect on throughput.

See also: writable.uncork(), writable._writev().

Returns

void

Since

v0.11.2

Inherited from

ServerResponse.cork

Defined in

node_modules/@types/node/stream.d.ts:830

---

created

▸ created(data?): void

Parameters

Name	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:28

---

destroy

▸ destroy(error?): this

Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the writable stream has ended and subsequent calls to write() or end() will result in an ERR_STREAM_DESTROYED error. This is a destructive and immediate way to destroy a stream. Previous calls towrite() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. Use end() instead of destroy if data should flush before close, or wait for the 'drain' event before destroying the stream.

Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

Implementors should not override this method, but instead implement writable._destroy().

Parameters

Name	Type	Description
error?	Error	Optional, an error to emit with 'error' event.

Returns

this

Since

v8.0.0

Inherited from

ServerResponse.destroy

Defined in

node_modules/@types/node/stream.d.ts:881

---

detachSocket

▸ detachSocket(socket): void

Parameters

Name	Type
socket	Socket

Returns

void

Inherited from

ServerResponse.detachSocket

Defined in

node_modules/@types/node/http.d.ts:743

---

emit

▸ emit(event): boolean

Parameters

Name	Type
event	"close"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:899

▸ emit(event): boolean

Parameters

Name	Type
event	"drain"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:900

▸ emit(event, err): boolean

Parameters

Name	Type
event	"error"
err	Error

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:901

▸ emit(event): boolean

Parameters

Name	Type
event	"finish"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:902

▸ emit(event, src): boolean

Parameters

Name	Type
event	"pipe"
src	Readable

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:903

▸ emit(event, src): boolean

Parameters

Name	Type
event	"unpipe"
src	Readable

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:904

▸ emit(event, ...args): boolean

Parameters

Name	Type
event	string | symbol
...args	any[]

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

node_modules/@types/node/stream.d.ts:905

---

end

▸ end(cb?): this

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
const fs = require('node:fs');
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Parameters

Name	Type
cb?	() => void

Returns

this

Since

v0.9.4

Inherited from

ServerResponse.end

Defined in

node_modules/@types/node/stream.d.ts:813

▸ end(chunk, cb?): this

Parameters

Name	Type
chunk	any
cb?	() => void

Returns

this

Inherited from

ServerResponse.end

Defined in

node_modules/@types/node/stream.d.ts:814

▸ end(chunk, encoding, cb?): this

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
cb?	() => void

Returns

this

Inherited from

ServerResponse.end

Defined in

node_modules/@types/node/stream.d.ts:815

---

error

▸ error(error, data?): void

Parameters

Name	Type
error	string | number
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:79

---

eventNames

▸ eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

ServerResponse.eventNames

Defined in

node_modules/@types/node/events.d.ts:883

---

flushHeaders

▸ flushHeaders(): void

Flushes the message headers.

For efficiency reason, Node.js normally buffers the message headers until outgoingMessage.end() is called or the first chunk of message data is written. It then tries to pack the headers and data into a single TCP packet.

It is usually desired (it saves a TCP round-trip), but not when the first data is not sent until possibly much later. outgoingMessage.flushHeaders()bypasses the optimization and kickstarts the message.

Returns

void

Since

v1.6.0

Inherited from

ServerResponse.flushHeaders

Defined in

node_modules/@types/node/http.d.ts:697

---

forbidden

▸ forbidden(data?): void

Parameters

Name	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:58

---

getHeader

▸ getHeader(name): undefined | string | number | string[]

Gets the value of the HTTP header with the given name. If that header is not set, the returned value will be undefined.

Parameters

Name	Type	Description
name	string	Name of header

Returns

undefined | string | number | string[]

Since

v0.4.0

Inherited from

ServerResponse.getHeader

Defined in

node_modules/@types/node/http.d.ts:614

---

getHeaderNames

▸ getHeaderNames(): string[]

Returns an array containing the unique names of the current outgoing headers. All names are lowercase.

Returns

string[]

Since

v7.7.0

Inherited from

ServerResponse.getHeaderNames

Defined in

node_modules/@types/node/http.d.ts:642

---

getHeaders

▸ getHeaders(): OutgoingHttpHeaders

Returns a shallow copy of the current outgoing headers. Since a shallow copy is used, array values may be mutated without additional calls to various header-related HTTP module methods. The keys of the returned object are the header names and the values are the respective header values. All header names are lowercase.

The object returned by the outgoingMessage.getHeaders() method does not prototypically inherit from the JavaScript Object. This means that typical Object methods such as obj.toString(), obj.hasOwnProperty(), and others are not defined and will not work.

outgoingMessage.setHeader('Foo', 'bar');
outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

const headers = outgoingMessage.getHeaders();
// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }

Returns

OutgoingHttpHeaders

Since

v7.7.0

Inherited from

ServerResponse.getHeaders

Defined in

node_modules/@types/node/http.d.ts:636

---

getMaxListeners

▸ getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

ServerResponse.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:735

---

hasHeader

▸ hasHeader(name): boolean

Returns true if the header identified by name is currently set in the outgoing headers. The header name is case-insensitive.

const hasContentType = outgoingMessage.hasHeader('content-type');

Parameters

Name	Type
name	string

Returns

boolean

Since

v7.7.0

Inherited from

ServerResponse.hasHeader

Defined in

node_modules/@types/node/http.d.ts:652

---

html

▸ html(code, data): void

Parameters

Name	Type
code	number
data	string

Returns

void

Since

5.1.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:139

---

image

▸ image(type, data): void

Parameters

Name	Type	Description
type	ImageGif | ImageJpg | ImagePng | ImageWebp | ImageXIcon	The MIME type of the image (e.g., MimeTypes.ImagePng).
data	string | Uint8Array | Readable | Buffer	The image data as a string, Buffer, Uint8Array, or ReadableStream.

Returns

void

Since

6.1.0

Sets the image content type and sends the image data in the response.

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:124

---

json

▸ json(data): void

Parameters

Name	Type
data	any

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:105

---

listenerCount

▸ listenerCount<K>(eventName, listener?): number

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type parameters

Name
K

Parameters

Name	Type	Description
eventName	string | symbol	The name of the event being listened for
listener?	Function	The event handler function

Returns

number

Since

v3.2.0

Inherited from

ServerResponse.listenerCount

Defined in

node_modules/@types/node/events.d.ts:829

---

listeners

▸ listeners<K>(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type parameters

Name
K

Parameters

Name	Type
eventName	string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

ServerResponse.listeners

Defined in

node_modules/@types/node/events.d.ts:748

---

noContent

▸ noContent(data?): void

Parameters

Name	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:36

---

notFound

▸ notFound(data?): void

Parameters

Name	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:65

---

off

▸ off<K>(eventName, listener): this

Alias for emitter.removeListener().

Type parameters

Name
K

Parameters

Name	Type
eventName	string | symbol
listener	(...args: any[]) => void

Returns

this

Since

v10.0.0

Inherited from

ServerResponse.off

Defined in

node_modules/@types/node/events.d.ts:708

---

ok

▸ ok(data?): void

Parameters

Name	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:20

---

on

▸ on(event, listener): this

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:906

▸ on(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:907

▸ on(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:908

▸ on(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:909

▸ on(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:910

▸ on(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:911

▸ on(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/stream.d.ts:912

---

once

▸ once(event, listener): this

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:913

▸ once(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:914

▸ once(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:915

▸ once(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:916

▸ once(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:917

▸ once(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:918

▸ once(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/stream.d.ts:919

---

pipe

▸ pipe<T>(destination, options?): T

Type parameters

Name	Type
T	extends WritableStream

Parameters

Name	Type
destination	T
options?	Object
options.end?	boolean

Returns

T

Inherited from

ServerResponse.pipe

Defined in

node_modules/@types/node/stream.d.ts:29

---

prependListener

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:920

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:921

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:922

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:923

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:924

▸ prependListener(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:925

▸ prependListener(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.prependListener

Defined in

node_modules/@types/node/stream.d.ts:926

---

prependOnceListener

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:927

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:928

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:929

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:930

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:931

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:932

▸ prependOnceListener(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.prependOnceListener

Defined in

node_modules/@types/node/stream.d.ts:933

---

rawListeners

▸ rawListeners<K>(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type parameters

Name
K

Parameters

Name	Type
eventName	string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

ServerResponse.rawListeners

Defined in

node_modules/@types/node/events.d.ts:779

---

removeAllListeners

▸ removeAllListeners(eventName?): this

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.

Parameters

Name	Type
eventName?	string | symbol

Returns

this

Since

v0.1.26

Inherited from

ServerResponse.removeAllListeners

Defined in

node_modules/@types/node/events.d.ts:719

---

removeHeader

▸ removeHeader(name): void

Removes a header that is queued for implicit sending.

outgoingMessage.removeHeader('Content-Encoding');

Parameters

Name	Type	Description
name	string	Header name

Returns

void

Since

v0.4.0

Inherited from

ServerResponse.removeHeader

Defined in

node_modules/@types/node/http.d.ts:662

---

removeListener

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"close"
listener	() => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:934

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:935

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"error"
listener	(err: Error) => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:936

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:937

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"pipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:938

▸ removeListener(event, listener): this

Parameters

Name	Type
event	"unpipe"
listener	(src: Readable) => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:939

▸ removeListener(event, listener): this

Parameters

Name	Type
event	string | symbol
listener	(...args: any[]) => void

Returns

this

Inherited from

ServerResponse.removeListener

Defined in

node_modules/@types/node/stream.d.ts:940

---

respond

▸ respond(data): void

Parameters

Name	Type
data	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:90

---

setContentType

▸ setContentType(contentType): this

Parameters

Name	Type
contentType	MimeTypes

Returns

this

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:146

---

setDefaultEncoding

▸ setDefaultEncoding(encoding): this

The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

Parameters

Name	Type	Description
encoding	BufferEncoding	The new default encoding

Returns

this

Since

v0.11.15

Inherited from

ServerResponse.setDefaultEncoding

Defined in

node_modules/@types/node/stream.d.ts:790

---

setHeader

▸ setHeader(name, value): this

Sets a single header value. If the header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings to send multiple headers with the same name.

Parameters

Name	Type	Description
name	string	Header name
value	string | number | readonly string[]	Header value

Returns

this

Since

v0.4.0

Inherited from

ServerResponse.setHeader

Defined in

node_modules/@types/node/http.d.ts:591

---

setMaxListeners

▸ setMaxListeners(n): this

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 toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

Name	Type
n	number

Returns

this

Since

v0.3.5

Inherited from

ServerResponse.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:729

---

setTimeout

▸ setTimeout(msecs, callback?): this

Once a socket is associated with the message and is connected,socket.setTimeout() will be called with msecs as the first parameter.

Parameters

Name	Type	Description
msecs	number	-
callback?	() => void	Optional function to be called when a timeout occurs. Same as binding to the timeout event.

Returns

this

Since

v0.9.12

Inherited from

ServerResponse.setTimeout

Defined in

node_modules/@types/node/http.d.ts:582

---

status

▸ status(code): this

Parameters

Name	Type
code	number

Returns

this

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:97

---

text

▸ text(data): void

Parameters

Name	Type
data	string

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:112

---

unauthorized

▸ unauthorized(data?): void

Parameters

Name	Type
data?	unknown

Returns

void

Since

1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:51

---

uncork

▸ uncork(): void

The writable.uncork() method flushes all data buffered since cork was called.

When using writable.cork() and writable.uncork() to manage the buffering of writes to a stream, defer calls to writable.uncork() usingprocess.nextTick(). Doing so allows batching of allwritable.write() calls that occur within a given Node.js event loop phase.

stream.cork();
stream.write('some ');
stream.write('data ');
process.nextTick(() => stream.uncork());

If the writable.cork() method is called multiple times on a stream, the same number of calls to writable.uncork() must be called to flush the buffered data.

stream.cork();
stream.write('some ');
stream.cork();
stream.write('data ');
process.nextTick(() => {
  stream.uncork();
  // The data will not be flushed until uncork() is called a second time.
  stream.uncork();
});

See also: writable.cork().

Returns

void

Since

v0.11.2

Inherited from

ServerResponse.uncork

Defined in

node_modules/@types/node/stream.d.ts:864

---

write

▸ write(chunk, callback?): boolean

The writable.write() method writes some data to the stream, and calls the supplied callback once the data has been fully handled. If an error occurs, the callback will be called with the error as its first argument. The callback is called asynchronously and before 'error' is emitted.

The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. If false is returned, further attempts to write data to the stream should stop until the 'drain' event is emitted.

While a stream is not draining, calls to write() will buffer chunk, and return false. Once all currently buffered chunks are drained (accepted for delivery by the operating system), the 'drain' event will be emitted. Once write() returns false, do not write more chunks until the 'drain' event is emitted. While calling write() on a stream that is not draining is allowed, Node.js will buffer all written chunks until maximum memory usage occurs, at which point it will abort unconditionally. Even before it aborts, high memory usage will cause poor garbage collector performance and high RSS (which is not typically released back to the system, even after the memory is no longer required). Since TCP sockets may never drain if the remote peer does not read the data, writing a socket that is not draining may lead to a remotely exploitable vulnerability.

Writing data while the stream is not draining is particularly problematic for a Transform, because the Transform streams are paused by default until they are piped or a 'data' or 'readable' event handler is added.

If the data to be written can be generated or fetched on demand, it is recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is possible to respect backpressure and avoid memory issues using the 'drain' event:

function write(data, cb) {
  if (!stream.write(data)) {
    stream.once('drain', cb);
  } else {
    process.nextTick(cb);
  }
}

// Wait for cb to be called before doing any other write.
write('hello', () => {
  console.log('Write completed, do more writes now.');
});

A Writable stream in object mode will always ignore the encoding argument.

Parameters

Name	Type	Description
chunk	any	Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any JavaScript value other than null.
callback?	(error: undefined | null | Error) => void	Callback for when this chunk of data is flushed.

Returns

boolean

false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

Since

v0.9.4

Inherited from

ServerResponse.write

Defined in

node_modules/@types/node/stream.d.ts:783

▸ write(chunk, encoding, callback?): boolean

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
callback?	(error: undefined | null | Error) => void

Returns

boolean

Inherited from

ServerResponse.write

Defined in

node_modules/@types/node/stream.d.ts:784

---

writeContinue

▸ writeContinue(callback?): void

Sends an HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent. See the 'checkContinue' event onServer.

Parameters

Name	Type
callback?	() => void

Returns

void

Since

v0.3.0

Inherited from

ServerResponse.writeContinue

Defined in

node_modules/@types/node/http.d.ts:749

---

writeEarlyHints

▸ writeEarlyHints(hints, callback?): void

Sends an HTTP/1.1 103 Early Hints message to the client with a Link header, indicating that the user agent can preload/preconnect the linked resources. The hints is an object containing the values of headers to be sent with early hints message. The optional callback argument will be called when the response message has been written.

Example

const earlyHintsLink = '</styles.css>; rel=preload; as=style';
response.writeEarlyHints({
  'link': earlyHintsLink,
});

const earlyHintsLinks = [
  '</styles.css>; rel=preload; as=style',
  '</scripts.js>; rel=preload; as=script',
];
response.writeEarlyHints({
  'link': earlyHintsLinks,
  'x-trace-id': 'id for diagnostics',
});

const earlyHintsCallback = () => console.log('early hints message sent');
response.writeEarlyHints({
  'link': earlyHintsLinks,
}, earlyHintsCallback);

Parameters

Name	Type	Description
hints	Record<string, string | string[]>	An object containing the values of headers
callback?	() => void	Will be called when the response message has been written

Returns

void

Since

v18.11.0

Inherited from

ServerResponse.writeEarlyHints

Defined in

node_modules/@types/node/http.d.ts:783

---

writeHead

▸ writeHead(statusCode, statusMessage?, headers?): this

Sends a response header to the request. The status code is a 3-digit HTTP status code, like 404. The last argument, headers, are the response headers. Optionally one can give a human-readable statusMessage as the second argument.

headers may be an Array where the keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values. The array is in the same format as request.rawHeaders.

Returns a reference to the ServerResponse, so that calls can be chained.

const body = 'hello world';
response
  .writeHead(200, {
    'Content-Length': Buffer.byteLength(body),
    'Content-Type': 'text/plain',
  })
  .end(body);

This method must only be called once on a message and it must be called before response.end() is called.

If response.write() or response.end() are called before calling this, the implicit/mutable headers will be calculated and call this function.

When headers have been set with response.setHeader(), they will be merged with any headers passed to response.writeHead(), with the headers passed to response.writeHead() given precedence.

If this method is called and response.setHeader() has not been called, it will directly write the supplied header values onto the network channel without caching internally, and the response.getHeader() on the header will not yield the expected result. If progressive population of headers is desired with potential future retrieval and modification, use response.setHeader() instead.

// Returns content-type = text/plain
const server = http.createServer((req, res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, { 'Content-Type': 'text/plain' });
  res.end('ok');
});

Content-Length is read in bytes, not characters. Use Buffer.byteLength() to determine the length of the body in bytes. Node.js will check whether Content-Length and the length of the body which has been transmitted are equal or not.

Attempting to set a header field name or value that contains invalid characters will result in a [Error][] being thrown.

Parameters

Name	Type
statusCode	number
statusMessage?	string
headers?	OutgoingHttpHeaders | OutgoingHttpHeader[]

Returns

this

Since

v0.1.30

Inherited from

ServerResponse.writeHead

Defined in

node_modules/@types/node/http.d.ts:841

▸ writeHead(statusCode, headers?): this

Parameters

Name	Type
statusCode	number
headers?	OutgoingHttpHeaders | OutgoingHttpHeader[]

Returns

this

Inherited from

ServerResponse.writeHead

Defined in

node_modules/@types/node/http.d.ts:846

---

writeProcessing

▸ writeProcessing(): void

Sends a HTTP/1.1 102 Processing message to the client, indicating that the request body should be sent.

Returns

void

Since

v10.0.0

Inherited from

ServerResponse.writeProcessing

Defined in

node_modules/@types/node/http.d.ts:852

---

addAbortListener

▸ addAbortListener(signal, resource): Disposable

Listens 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]();
  }
}

Parameters

Name	Type
signal	AbortSignal
resource	(event: Event) => void

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Inherited from

ServerResponse.addAbortListener

Defined in

node_modules/@types/node/events.d.ts:400

---

fromWeb

▸ fromWeb(writableStream, options?): Writable

A utility method for creating a Writable from a web WritableStream.

Parameters

Name	Type
writableStream	WritableStream<any>
options?	Pick<WritableOptions, "signal" | "highWaterMark" | "objectMode" | "decodeStrings">

Returns

Writable

Since

v17.0.0

Inherited from

ServerResponse.fromWeb

Defined in

node_modules/@types/node/stream.d.ts:1006

---

getEventListeners

▸ getEventListeners(emitter, name): Function[]

Returns 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] ]
}

Parameters

Name	Type
emitter	EventEmitter<DefaultEventMap> | _DOMEventTarget
name	string | symbol

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

ServerResponse.getEventListeners

Defined in

node_modules/@types/node/events.d.ts:321

---

getMaxListeners

▸ getMaxListeners(emitter): number

Returns 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
}

Parameters

Name	Type
emitter	EventEmitter<DefaultEventMap> | _DOMEventTarget

Returns

number

Since

v19.9.0

Inherited from

ServerResponse.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:350

---

listenerCount

▸ listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered 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

Parameters

Name	Type	Description
emitter	EventEmitter<DefaultEventMap>	The emitter to query
eventName	string | symbol	The event name

Returns

number

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Inherited from

ServerResponse.listenerCount

Defined in

node_modules/@types/node/events.d.ts:293

---

on

▸ on(emitter, eventName, options?): AsyncIterableIterator<any>

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());

Parameters

Name	Type	Description
emitter	EventEmitter<DefaultEventMap>	-
eventName	string	The name of the event being listened for
options?	StaticEventEmitterOptions	-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

ServerResponse.on

Defined in

node_modules/@types/node/events.d.ts:271

▸ on<Emitter, Events>(eventEmitter, eventName): AsyncIterableIterator<Emitter extends Client<boolean> ? ClientEvents[Events] : any>

Type parameters

Name	Type
Emitter	extends __module
Events	extends keyof ClientEvents

Parameters

Name	Type
eventEmitter	Emitter
eventName	Emitter extends Client<boolean> ? Events : string

Returns

AsyncIterableIterator<Emitter extends Client<boolean> ? ClientEvents[Events] : any>

Inherited from

ServerResponse.on

Defined in

node_modules/discord.js/typings/index.d.ts:243

---

once

▸ once(emitter, eventName, options?): Promise<any[]>

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!

Parameters

Name	Type
emitter	EventEmitter<DefaultEventMap>
eventName	string | symbol
options?	StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/events.d.ts:206

▸ once(emitter, eventName, options?): Promise<any[]>

Parameters

Name	Type
emitter	_DOMEventTarget
eventName	string
options?	StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

ServerResponse.once

Defined in

node_modules/@types/node/events.d.ts:211

▸ once<Emitter, Event>(eventEmitter, eventName): Promise<Emitter extends Client<boolean> ? ClientEvents[Event] : any[]>

Type parameters

Name	Type
Emitter	extends __module
Event	extends keyof ClientEvents

Parameters

Name	Type
eventEmitter	Emitter
eventName	Emitter extends Client<boolean> ? Event : string

Returns

Promise<Emitter extends Client<boolean> ? ClientEvents[Event] : any[]>

Inherited from

ServerResponse.once

Defined in

node_modules/discord.js/typings/index.d.ts:239

---

setMaxListeners

▸ setMaxListeners(n?, ...eventTargets): void

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

Name	Type	Description
n?	number	A non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets	(EventEmitter<DefaultEventMap> | _DOMEventTarget)[]	-

Returns

void

Since

v15.4.0

Inherited from

ServerResponse.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:365

---

toWeb

▸ toWeb(streamWritable): WritableStream<any>

A utility method for creating a web WritableStream from a Writable.

Parameters

Name	Type
streamWritable	Writable

Returns

WritableStream<any>

Since

v17.0.0

Inherited from

ServerResponse.toWeb

Defined in

node_modules/@types/node/stream.d.ts:1015