Skip to main content

Class: ApiResponse

@sapphire/plugin-api.ApiResponse

since 1.0.0

Hierarchy

  • ServerResponse

    โ†ณ ApiResponse

Constructors

constructor

โ€ข new ApiResponse(req)

Parameters

NameType
reqIncomingMessage

Inherited from

ServerResponse.constructor

Defined in

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

Properties

chunkedEncoding

โ€ข chunkedEncoding: boolean

Inherited from

ServerResponse.chunkedEncoding

Defined in

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


connection

โ€ข Readonly connection: null | Socket

Aliases of outgoingMessage.socket

since v0.3.0

deprecated Since v15.12.0 - Use socket instead.

Inherited from

ServerResponse.connection

Defined in

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


cookies

โ€ข cookies: CookieStore

since 1.0.0

Defined in

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


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:543


finished

โ€ข finished: boolean

deprecated Use writableEnded instead.

Inherited from

ServerResponse.finished

Defined in

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


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:340


req

โ€ข Readonly req: IncomingMessage

Inherited from

ServerResponse.req

Defined in

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


sendDate

โ€ข sendDate: boolean

Inherited from

ServerResponse.sendDate

Defined in

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


shouldKeepAlive

โ€ข shouldKeepAlive: boolean

Inherited from

ServerResponse.shouldKeepAlive

Defined in

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


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:354


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:478


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:493


useChunkedEncodingByDefault

โ€ข useChunkedEncodingByDefault: boolean

Inherited from

ServerResponse.useChunkedEncodingByDefault

Defined in

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


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:504


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:538


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:510


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:515


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:520


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:527


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:532


captureRejectionSymbol

โ–ช Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

ServerResponse.captureRejectionSymbol

Defined in

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


captureRejections

โ–ช Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

ServerResponse.captureRejections

Defined in

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


defaultMaxListeners

โ–ช Static defaultMaxListeners: number

Inherited from

ServerResponse.defaultMaxListeners

Defined in

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


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.

Inherited from

ServerResponse.errorMonitor

Defined in

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

Methods

_construct

โ–ธ Optional _construct(callback): void

Parameters

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

Returns

void

Inherited from

ServerResponse._construct

Defined in

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


_destroy

โ–ธ _destroy(error, callback): void

Parameters

NameType
errornull | Error
callback(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._destroy

Defined in

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


_final

โ–ธ _final(callback): void

Parameters

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

Returns

void

Inherited from

ServerResponse._final

Defined in

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


_write

โ–ธ _write(chunk, encoding, callback): void

Parameters

NameType
chunkany
encodingBufferEncoding
callback(error?: null | Error) => void

Returns

void

Inherited from

ServerResponse._write

Defined in

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


_writev

โ–ธ Optional _writev(chunks, callback): void

Parameters

NameType
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:546


addListener

โ–ธ addListener(event, listener): ApiResponse

Event emitter The defined events on documents including:

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

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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

โ–ธ addListener(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.addListener

Defined in

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


addTrailers

โ–ธ addTrailers(headers): void

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

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

HTTP requires the Trailer header to be sent to emit trailers, with a list of header fields 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.

since v0.3.0

Parameters

NameType
headersOutgoingHttpHeaders | readonly [string, string][]

Returns

void

Inherited from

ServerResponse.addTrailers

Defined in

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


assignSocket

โ–ธ assignSocket(socket): void

Parameters

NameType
socketSocket

Returns

void

Inherited from

ServerResponse.assignSocket

Defined in

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


badRequest

โ–ธ badRequest(data?): void

since 1.0.0

Parameters

NameType
data?unknown

Returns

void

Defined in

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


conflict

โ–ธ conflict(data?): void

since 1.0.0

Parameters

NameType
data?unknown

Returns

void

Defined in

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


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 {@link 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().

since v0.11.2

Returns

void

Inherited from

ServerResponse.cork

Defined in

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


created

โ–ธ created(data?): void

since 1.0.0

Parameters

NameType
dataunknown

Returns

void

Defined in

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


destroy

โ–ธ destroy(error?): void

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

since v8.0.0

Parameters

NameTypeDescription
error?ErrorOptional, an error to emit with 'error' event.

Returns

void

Inherited from

ServerResponse.destroy

Defined in

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


detachSocket

โ–ธ detachSocket(socket): void

Parameters

NameType
socketSocket

Returns

void

Inherited from

ServerResponse.detachSocket

Defined in

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


emit

โ–ธ emit(event): boolean

Parameters

NameType
event"close"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event): boolean

Parameters

NameType
event"drain"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event, err): boolean

Parameters

NameType
event"error"
errError

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event): boolean

Parameters

NameType
event"finish"

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event, src): boolean

Parameters

NameType
event"pipe"
srcReadable

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event, src): boolean

Parameters

NameType
event"unpipe"
srcReadable

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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

โ–ธ emit(event, ...args): boolean

Parameters

NameType
eventstring | symbol
...argsany[]

Returns

boolean

Inherited from

ServerResponse.emit

Defined in

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


end

โ–ธ end(cb?): void

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 {@link end} will raise an error.

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

since v0.9.4

Parameters

NameType
cb?() => void

Returns

void

Inherited from

ServerResponse.end

Defined in

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

โ–ธ end(chunk, cb?): void

Parameters

NameType
chunkany
cb?() => void

Returns

void

Inherited from

ServerResponse.end

Defined in

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

โ–ธ end(chunk, encoding, cb?): void

Parameters

NameType
chunkany
encodingBufferEncoding
cb?() => void

Returns

void

Inherited from

ServerResponse.end

Defined in

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


error

โ–ธ error(error, data?): void

since 1.0.0

Parameters

NameType
errorstring | number
data?unknown

Returns

void

Defined in

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


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.

const EventEmitter = require('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) ]

since v6.0.0

Returns

(string | symbol)[]

Inherited from

ServerResponse.eventNames

Defined in

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


flushHeaders

โ–ธ flushHeaders(): void

Compulsorily 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 request.

since v1.6.0

Returns

void

Inherited from

ServerResponse.flushHeaders

Defined in

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


forbidden

โ–ธ forbidden(data?): void

since 1.0.0

Parameters

NameType
data?unknown

Returns

void

Defined in

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


getHeader

โ–ธ getHeader(name): undefined | string | number | string[]

Gets the value of HTTP header with the given name. If such a name doesn't exist in message, it will be undefined.

since v0.4.0

Parameters

NameTypeDescription
namestringName of header

Returns

undefined | string | number | string[]

Inherited from

ServerResponse.getHeader

Defined in

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


getHeaderNames

โ–ธ getHeaderNames(): string[]

Returns an array of names of headers of the outgoing outgoingMessage. All names are lowercase.

since v8.0.0

Returns

string[]

Inherited from

ServerResponse.getHeaderNames

Defined in

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


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

since v8.0.0

Returns

OutgoingHttpHeaders

Inherited from

ServerResponse.getHeaders

Defined in

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


getMaxListeners

โ–ธ getMaxListeners(): number

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

since v1.0.0

Returns

number

Inherited from

ServerResponse.getMaxListeners

Defined in

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


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

since v8.0.0

Parameters

NameType
namestring

Returns

boolean

Inherited from

ServerResponse.hasHeader

Defined in

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


json

โ–ธ json(data): void

since 1.0.0

Parameters

NameType
dataany

Returns

void

Defined in

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


listenerCount

โ–ธ listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

since v3.2.0

Parameters

NameTypeDescription
eventNamestring | symbolThe name of the event being listened for

Returns

number

Inherited from

ServerResponse.listenerCount

Defined in

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


listeners

โ–ธ listeners(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] ]

since v0.1.26

Parameters

NameType
eventNamestring | symbol

Returns

Function[]

Inherited from

ServerResponse.listeners

Defined in

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


noContent

โ–ธ noContent(data?): void

since 1.0.0

Parameters

NameType
dataunknown

Returns

void

Defined in

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


notFound

โ–ธ notFound(data?): void

since 1.0.0

Parameters

NameType
data?unknown

Returns

void

Defined in

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


off

โ–ธ off(eventName, listener): ApiResponse

Alias for emitter.removeListener().

since v10.0.0

Parameters

NameType
eventNamestring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.off

Defined in

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


ok

โ–ธ ok(data?): void

since 1.0.0

Parameters

NameType
dataunknown

Returns

void

Defined in

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


on

โ–ธ on(event, listener): ApiResponse

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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

โ–ธ on(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.on

Defined in

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


once

โ–ธ once(event, listener): ApiResponse

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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

โ–ธ once(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.once

Defined in

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


pipe

โ–ธ pipe<T>(destination, options?): T

Type parameters

NameType
Textends WritableStream<T>

Parameters

NameType
destinationT
options?Object
options.end?boolean

Returns

T

Inherited from

ServerResponse.pipe

Defined in

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


prependListener

โ–ธ prependListener(event, listener): ApiResponse

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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

โ–ธ prependListener(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.prependListener

Defined in

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


prependOnceListener

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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

โ–ธ prependOnceListener(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.prependOnceListener

Defined in

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


rawListeners

โ–ธ rawListeners(eventName): Function[]

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

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

since v9.4.0

Parameters

NameType
eventNamestring | symbol

Returns

Function[]

Inherited from

ServerResponse.rawListeners

Defined in

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


removeAllListeners

โ–ธ removeAllListeners(event?): ApiResponse

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

Parameters

NameType
event?string | symbol

Returns

ApiResponse

Inherited from

ServerResponse.removeAllListeners

Defined in

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


removeHeader

โ–ธ removeHeader(name): void

Removes a header that is queued for implicit sending.

outgoingMessage.removeHeader('Content-Encoding');

since v0.4.0

Parameters

NameType
namestring

Returns

void

Inherited from

ServerResponse.removeHeader

Defined in

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


removeListener

โ–ธ removeListener(event, listener): ApiResponse

Parameters

NameType
event"close"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

NameType
event"drain"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

NameType
event"finish"
listener() => void

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

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

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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

โ–ธ removeListener(event, listener): ApiResponse

Parameters

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns

ApiResponse

Inherited from

ServerResponse.removeListener

Defined in

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


respond

โ–ธ respond(data): void

since 1.0.0

Parameters

NameType
dataunknown

Returns

void

Defined in

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


setContentType

โ–ธ setContentType(contentType): ApiResponse

since 1.0.0

Parameters

NameType
contentTypeMimeTypes

Returns

ApiResponse

Defined in

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


setDefaultEncoding

โ–ธ setDefaultEncoding(encoding): ApiResponse

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

since v0.11.15

Parameters

NameTypeDescription
encodingBufferEncodingThe new default encoding

Returns

ApiResponse

Inherited from

ServerResponse.setDefaultEncoding

Defined in

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


setHeader

โ–ธ setHeader(name, value): ApiResponse

Sets a single header value for the header object.

since v0.4.0

Parameters

NameTypeDescription
namestringHeader name
valuestring | number | readonly string[]Header value

Returns

ApiResponse

Inherited from

ServerResponse.setHeader

Defined in

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


setMaxListeners

โ–ธ setMaxListeners(n): ApiResponse

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.

since v0.3.5

Parameters

NameType
nnumber

Returns

ApiResponse

Inherited from

ServerResponse.setMaxListeners

Defined in

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


setTimeout

โ–ธ setTimeout(msecs, callback?): ApiResponse

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

since v0.9.12

Parameters

NameTypeDescription
msecsnumber-
callback?() => voidOptional function to be called when a timeout occurs. Same as binding to the timeout event.

Returns

ApiResponse

Inherited from

ServerResponse.setTimeout

Defined in

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


status

โ–ธ status(code): ApiResponse

since 1.0.0

Parameters

NameType
codenumber

Returns

ApiResponse

Defined in

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


text

โ–ธ text(data): void

since 1.0.0

Parameters

NameType
datastring

Returns

void

Defined in

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


unauthorized

โ–ธ unauthorized(data?): void

since 1.0.0

Parameters

NameType
data?unknown

Returns

void

Defined in

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


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, it is recommended that calls to writable.uncork() be deferred using process.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().

since v0.11.2

Returns

void

Inherited from

ServerResponse.uncork

Defined in

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


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. It is recommended that once write() returns false, no more chunks be written 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.

since v0.9.4

Parameters

NameTypeDescription
chunkanyOptional 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) => voidCallback 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.

Inherited from

ServerResponse.write

Defined in

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

โ–ธ write(chunk, encoding, callback?): boolean

Parameters

NameType
chunkany
encodingBufferEncoding
callback?(error: undefined | null | Error) => void

Returns

boolean

Inherited from

ServerResponse.write

Defined in

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


writeContinue

โ–ธ writeContinue(callback?): void

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

since v0.3.0

Parameters

NameType
callback?() => void

Returns

void

Inherited from

ServerResponse.writeContinue

Defined in

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


writeHead

โ–ธ writeHead(statusCode, statusMessage?, headers?): ApiResponse

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 given in bytes, not characters. Use Buffer.byteLength() to determine the length of the body in bytes. Node.js does not 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 TypeError being thrown.

since v0.1.30

Parameters

NameType
statusCodenumber
statusMessage?string
headers?OutgoingHttpHeaders | OutgoingHttpHeader[]

Returns

ApiResponse

Inherited from

ServerResponse.writeHead

Defined in

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

โ–ธ writeHead(statusCode, headers?): ApiResponse

Parameters

NameType
statusCodenumber
headers?OutgoingHttpHeaders | OutgoingHttpHeader[]

Returns

ApiResponse

Inherited from

ServerResponse.writeHead

Defined in

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


writeProcessing

โ–ธ writeProcessing(): void

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

since v10.0.0

Returns

void

Inherited from

ServerResponse.writeProcessing

Defined in

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


getEventListeners

โ–ธ Static 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.

const { getEventListeners, EventEmitter } = require('events');

{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}

since v15.2.0

Parameters

NameType
emitterDOMEventTarget | EventEmitter
namestring | symbol

Returns

Function[]

Inherited from

ServerResponse.getEventListeners

Defined in

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


listenerCount

โ–ธ Static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

since v0.9.12

deprecated Since v3.2.0 - Use listenerCount instead.

Parameters

NameTypeDescription
emitterEventEmitterThe emitter to query
eventNamestring | symbolThe event name

Returns

number

Inherited from

ServerResponse.listenerCount

Defined in

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


on

โ–ธ Static on(emitter, eventName, options?): AsyncIterableIterator<any>

const { on, EventEmitter } = require('events');

(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')) {
// 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:

const { on, EventEmitter } = require('events');
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());

since v13.6.0, v12.16.0

Parameters

NameTypeDescription
emitterEventEmitter-
eventNamestringThe name of the event being listened for
options?StaticEventEmitterOptions-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Inherited from

ServerResponse.on

Defined in

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


once

โ–ธ Static 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.

const { once, EventEmitter } = require('events');

async function run() {
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.log('error happened', err);
}
}

run();

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:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('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

Parameters

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

ServerResponse.once

Defined in

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

โ–ธ Static once(emitter, eventName, options?): Promise<any[]>

Parameters

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

ServerResponse.once

Defined in

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