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
)
Type parameters
Name | Type |
---|---|
Request | extends IncomingMessage <Request > = IncomingMessage |
Parameters
Name | Type |
---|---|
req | Request |
Inherited from
ServerResponse<Request>.constructor
Defined in
node_modules/@types/node/http.d.ts:649
Properties
chunkedEncoding
• chunkedEncoding: boolean
Inherited from
ServerResponse.chunkedEncoding
Defined in
node_modules/@types/node/http.d.ts:459
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:584
connection
• Readonly
connection: null
| Socket
Aliases 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:477
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:579
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:589
finished
• finished: boolean
Deprecated
Use writableEnded
instead.
Inherited from
ServerResponse.finished
Defined in
node_modules/@types/node/http.d.ts:466
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:471
req
• Readonly
req: Request
Inherited from
ServerResponse.req
Defined in
node_modules/@types/node/http.d.ts:458
sendDate
• sendDate: boolean
Inherited from
ServerResponse.sendDate
Defined in
node_modules/@types/node/http.d.ts:462
shouldKeepAlive
• shouldKeepAlive: boolean
Inherited from
ServerResponse.shouldKeepAlive
Defined in
node_modules/@types/node/http.d.ts:460
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:485
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:625
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:640
strictContentLength
• strictContentLength: boolean
If set to true
, Node.js will check whether the Content-Length
header 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:648
useChunkedEncodingByDefault
• useChunkedEncodingByDefault: boolean
Inherited from
ServerResponse.useChunkedEncodingByDefault
Defined in
node_modules/@types/node/http.d.ts:461
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:540
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:574
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:546
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:551
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:556
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:563
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:594
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:568
captureRejectionSymbol
▪ Static
Readonly
captureRejectionSymbol: typeof captureRejectionSymbol
Inherited from
ServerResponse.captureRejectionSymbol
Defined in
node_modules/@types/node/events.d.ts:328
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:333
defaultMaxListeners
▪ Static
defaultMaxListeners: number
Inherited from
ServerResponse.defaultMaxListeners
Defined in
node_modules/@types/node/events.d.ts:334
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:327
Methods
_construct
▸ Optional
_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:604
_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:605
_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:606
_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:596
_writev
▸ Optional
_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:597
addListener
▸ addListener(event
, listener
): ApiResponse
<Request
>
Event emitter The defined events on documents including:
- close
- drain
- error
- finish
- pipe
- unpipe
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:772
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:773
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:774
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:775
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:776
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:777
▸ addListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.addListener
Defined in
node_modules/@types/node/stream.d.ts:778
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
Name | Type |
---|---|
headers | OutgoingHttpHeaders | readonly [string , string ][] |
Returns
void
Inherited from
ServerResponse.addTrailers
Defined in
node_modules/@types/node/http.d.ts:591
appendHeader
▸ appendHeader(name
, value
): ApiResponse
<Request
>
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 ;
.
Since
v18.3.0, v16.17.0
Parameters
Name | Type | Description |
---|---|---|
name | string | Header name |
value | string | readonly string [] | Header value |
Returns
Inherited from
ServerResponse.appendHeader
Defined in
node_modules/@types/node/http.d.ts:514
assignSocket
▸ assignSocket(socket
): void
Parameters
Name | Type |
---|---|
socket | Socket |
Returns
void
Inherited from
ServerResponse.assignSocket
Defined in
node_modules/@types/node/http.d.ts:650
badRequest
▸ badRequest(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
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
Name | Type |
---|---|
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 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:710
created
▸ created(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | unknown |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:26
destroy
▸ destroy(error?
): ApiResponse
<Request
>
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
Name | Type | Description |
---|---|---|
error? | Error | Optional, an error to emit with 'error' event. |
Returns
Inherited from
ServerResponse.destroy
Defined in
node_modules/@types/node/stream.d.ts:761
detachSocket
▸ detachSocket(socket
): void
Parameters
Name | Type |
---|---|
socket | Socket |
Returns
void
Inherited from
ServerResponse.detachSocket
Defined in
node_modules/@types/node/http.d.ts:651
emit
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "close" |
Returns
boolean
Inherited from
ServerResponse.emit
Defined in
node_modules/@types/node/stream.d.ts:779
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "drain" |
Returns
boolean
Inherited from
ServerResponse.emit
Defined in
node_modules/@types/node/stream.d.ts:780
▸ 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:781
▸ emit(event
): boolean
Parameters
Name | Type |
---|---|
event | "finish" |
Returns
boolean
Inherited from
ServerResponse.emit
Defined in
node_modules/@types/node/stream.d.ts:782
▸ 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:783
▸ 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:784
▸ 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:785
end
▸ end(cb?
): ApiResponse
<Request
>
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('fs');
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!
Since
v0.9.4
Parameters
Name | Type |
---|---|
cb? | () => void |
Returns
Inherited from
ServerResponse.end
Defined in
node_modules/@types/node/stream.d.ts:693
▸ end(chunk
, cb?
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
chunk | any |
cb? | () => void |
Returns
Inherited from
ServerResponse.end
Defined in
node_modules/@types/node/stream.d.ts:694
▸ end(chunk
, encoding
, cb?
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
chunk | any |
encoding | BufferEncoding |
cb? | () => void |
Returns
Inherited from
ServerResponse.end
Defined in
node_modules/@types/node/stream.d.ts:695
error
▸ error(error
, data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
error | string | 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 Symbol
s.
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:673
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:604
forbidden
▸ forbidden(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
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
Name | Type | Description |
---|---|---|
name | string | Name of header |
Returns
undefined
| string
| number
| string
[]
Inherited from
ServerResponse.getHeader
Defined in
node_modules/@types/node/http.d.ts:521
getHeaderNames
▸ getHeaderNames(): string
[]
Returns an array of names of headers of the outgoing outgoingMessage. All names are lowercase.
Since
v7.7.0
Returns
string
[]
Inherited from
ServerResponse.getHeaderNames
Defined in
node_modules/@types/node/http.d.ts:549
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
v7.7.0
Returns
OutgoingHttpHeaders
Inherited from
ServerResponse.getHeaders
Defined in
node_modules/@types/node/http.d.ts:543
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:526
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
v7.7.0
Parameters
Name | Type |
---|---|
name | string |
Returns
boolean
Inherited from
ServerResponse.hasHeader
Defined in
node_modules/@types/node/http.d.ts:559
json
▸ json(data
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | any |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:103
listenerCount
▸ listenerCount(eventName
, listener?
): number
Returns the number of listeners listening to 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.
Since
v3.2.0
Parameters
Name | Type | Description |
---|---|---|
eventName | string | symbol | The name of the event being listened for |
listener? | Function | The event handler function |
Returns
number
Inherited from
ServerResponse.listenerCount
Defined in
node_modules/@types/node/events.d.ts:620
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
Name | Type |
---|---|
eventName | string | symbol |
Returns
Function
[]
Inherited from
ServerResponse.listeners
Defined in
node_modules/@types/node/events.d.ts:539
noContent
▸ noContent(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | unknown |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:34
notFound
▸ notFound(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data? | unknown |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:63
off
▸ off(eventName
, listener
): ApiResponse
<Request
>
Alias for emitter.removeListener()
.
Since
v10.0.0
Parameters
Name | Type |
---|---|
eventName | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.off
Defined in
node_modules/@types/node/events.d.ts:499
ok
▸ ok(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | unknown |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:18
on
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:786
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:787
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:788
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:789
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:790
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:791
▸ on(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.on
Defined in
node_modules/@types/node/stream.d.ts:792
once
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:793
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:794
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:795
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:796
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:797
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:798
▸ once(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/stream.d.ts:799
pipe
▸ pipe<T
>(destination
, options?
): T
Type parameters
Name | Type |
---|---|
T | extends WritableStream <T > |
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:26
prependListener
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:800
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:801
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:802
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:803
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:804
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:805
▸ prependListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.prependListener
Defined in
node_modules/@types/node/stream.d.ts:806
prependOnceListener
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:807
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:808
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:809
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:810
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:811
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:812
▸ prependOnceListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.prependOnceListener
Defined in
node_modules/@types/node/stream.d.ts:813
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
Name | Type |
---|---|
eventName | string | symbol |
Returns
Function
[]
Inherited from
ServerResponse.rawListeners
Defined in
node_modules/@types/node/events.d.ts:569
removeAllListeners
▸ removeAllListeners(event?
): ApiResponse
<Request
>
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
Name | Type |
---|---|
event? | string | symbol |
Returns
Inherited from
ServerResponse.removeAllListeners
Defined in
node_modules/@types/node/events.d.ts:510
removeHeader
▸ removeHeader(name
): void
Removes a header that is queued for implicit sending.
outgoingMessage.removeHeader('Content-Encoding');
Since
v0.4.0
Parameters
Name | Type | Description |
---|---|---|
name | string | Header name |
Returns
void
Inherited from
ServerResponse.removeHeader
Defined in
node_modules/@types/node/http.d.ts:569
removeListener
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "close" |
listener | () => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:814
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "drain" |
listener | () => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:815
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:816
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "finish" |
listener | () => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:817
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "pipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:818
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | "unpipe" |
listener | (src : Readable ) => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:819
▸ removeListener(event
, listener
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
Returns
Inherited from
ServerResponse.removeListener
Defined in
node_modules/@types/node/stream.d.ts:820
respond
▸ respond(data
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | unknown |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:88
setContentType
▸ setContentType(contentType
): ApiResponse
<Request
>
Since
1.0.0
Parameters
Name | Type |
---|---|
contentType | MimeTypes |
Returns
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:117
setDefaultEncoding
▸ setDefaultEncoding(encoding
): ApiResponse
<Request
>
The writable.setDefaultEncoding()
method sets the default encoding
for a Writable
stream.
Since
v0.11.15
Parameters
Name | Type | Description |
---|---|---|
encoding | BufferEncoding | The new default encoding |
Returns
Inherited from
ServerResponse.setDefaultEncoding
Defined in
node_modules/@types/node/stream.d.ts:670
setHeader
▸ setHeader(name
, value
): ApiResponse
<Request
>
Sets a single header value for the header object. 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.
Since
v0.4.0
Parameters
Name | Type | Description |
---|---|---|
name | string | Header name |
value | string | number | readonly string [] | Header value |
Returns
Inherited from
ServerResponse.setHeader
Defined in
node_modules/@types/node/http.d.ts:500
setMaxListeners
▸ setMaxListeners(n
): ApiResponse
<Request
>
By default EventEmitter
s 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
Name | Type |
---|---|
n | number |
Returns
Inherited from
ServerResponse.setMaxListeners
Defined in
node_modules/@types/node/events.d.ts:520
setTimeout
▸ setTimeout(msecs
, callback?
): ApiResponse
<Request
>
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
Name | Type | Description |
---|---|---|
msecs | number | - |
callback? | () => void | Optional function to be called when a timeout occurs. Same as binding to the timeout event. |
Returns
Inherited from
ServerResponse.setTimeout
Defined in
node_modules/@types/node/http.d.ts:492
status
▸ status(code
): ApiResponse
<Request
>
Since
1.0.0
Parameters
Name | Type |
---|---|
code | number |
Returns
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:95
text
▸ text(data
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
data | string |
Returns
void
Defined in
projects/plugins/packages/api/src/lib/structures/api/ApiResponse.ts:110
unauthorized
▸ unauthorized(data?
): void
Since
1.0.0
Parameters
Name | Type |
---|---|
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, 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()
.
Since
v0.11.2
Returns
void
Inherited from
ServerResponse.uncork
Defined in
node_modules/@types/node/stream.d.ts:744
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.
Since
v0.9.4
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
.
Inherited from
ServerResponse.write
Defined in
node_modules/@types/node/stream.d.ts:663
▸ 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:664
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
.
Since
v0.3.0
Parameters
Name | Type |
---|---|
callback? | () => void |
Returns
void
Inherited from
ServerResponse.writeContinue
Defined in
node_modules/@types/node/http.d.ts:657
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);
Since
v18.11.0
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
Inherited from
ServerResponse.writeEarlyHints
Defined in
node_modules/@types/node/http.d.ts:692
writeHead
▸ writeHead(statusCode
, statusMessage?
, headers?
): ApiResponse
<Request
>
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
Name | Type |
---|---|
statusCode | number |
statusMessage? | string |
headers? | OutgoingHttpHeaders | OutgoingHttpHeader [] |
Returns
Inherited from
ServerResponse.writeHead
Defined in
node_modules/@types/node/http.d.ts:750
▸ writeHead(statusCode
, headers?
): ApiResponse
<Request
>
Parameters
Name | Type |
---|---|
statusCode | number |
headers? | OutgoingHttpHeaders | OutgoingHttpHeader [] |
Returns
Inherited from
ServerResponse.writeHead
Defined in
node_modules/@types/node/http.d.ts:755
writeProcessing
▸ writeProcessing(): void
Sends an 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:761
fromWeb
▸ Static
fromWeb(writableStream
, options?
): Writable
A utility method for creating a Writable
from a web WritableStream
.
Since
v17.0.0
Parameters
Name | Type |
---|---|
writableStream | WritableStream <any > |
options? | Pick <WritableOptions , "signal" | "highWaterMark" | "objectMode" | "decodeStrings" > |
Returns
Writable
Inherited from
ServerResponse.fromWeb
Defined in
node_modules/@types/node/stream.d.ts:528
getEventListeners
▸ Static
getEventListeners(emitter
, name
): Function
[]
Returns a copy of the array of listeners for the event named eventName
.
For EventEmitter
s this behaves exactly the same as calling .listeners
on
the emitter.
For EventTarget
s 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, v14.17.0
Parameters
Name | Type |
---|---|
emitter | EventEmitter | _DOMEventTarget |
name | string | symbol |
Returns
Function
[]
Inherited from
ServerResponse.getEventListeners
Defined in
node_modules/@types/node/events.d.ts:299
listenerCount
▸ Static
listenerCount(emitter
, eventName
): number
A class method that returns the number of listeners for the given eventName
registered 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
Name | Type | Description |
---|---|---|
emitter | EventEmitter | The emitter to query |
eventName | string | symbol | The event name |
Returns
number
Inherited from
ServerResponse.listenerCount
Defined in
node_modules/@types/node/events.d.ts:271
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
Name | Type | Description |
---|---|---|
emitter | EventEmitter | - |
eventName | string | The 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:254
▸ Static
on<E
, K
>(eventEmitter
, eventName
): AsyncIterableIterator
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
>
Type parameters
Name | Type |
---|---|
E | extends __module |
K | extends keyof ClientEvents |
Parameters
Name | Type |
---|---|
eventEmitter | E |
eventName | E extends Client <boolean > ? K : string |
Returns
AsyncIterableIterator
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
>
Inherited from
ServerResponse.on
Defined in
node_modules/discord.js/typings/index.d.ts:229
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
Name | Type |
---|---|
emitter | _NodeEventTarget |
eventName | string | symbol |
options? | StaticEventEmitterOptions |
Returns
Promise
<any
[]>
Inherited from
ServerResponse.once
Defined in
node_modules/@types/node/events.d.ts:194
▸ Static
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:195
▸ Static
once<E
, K
>(eventEmitter
, eventName
): Promise
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
[]>
Type parameters
Name | Type |
---|---|
E | extends __module |
K | extends keyof ClientEvents |
Parameters
Name | Type |
---|---|
eventEmitter | E |
eventName | E extends Client <boolean > ? K : string |
Returns
Promise
<E
extends Client
<boolean
> ? ClientEvents
[K
] : any
[]>
Inherited from
ServerResponse.once
Defined in
node_modules/discord.js/typings/index.d.ts:225
setMaxListeners
▸ Static
setMaxListeners(n?
, ...eventTargets
): void
const {
setMaxListeners,
EventEmitter
} = require('events');
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
Since
v15.4.0
Parameters
Name | Type | Description |
---|---|---|
n? | number | A non-negative number. The maximum number of listeners per EventTarget event. |
...eventTargets | (EventEmitter | _DOMEventTarget )[] | - |
Returns
void
Inherited from
ServerResponse.setMaxListeners
Defined in
node_modules/@types/node/events.d.ts:317
toWeb
▸ Static
toWeb(streamWritable
): WritableStream
<any
>
A utility method for creating a web WritableStream
from a Writable
.
Since
v17.0.0
Parameters
Name | Type |
---|---|
streamWritable | Writable |
Returns
WritableStream
<any
>
Inherited from
ServerResponse.toWeb
Defined in
node_modules/@types/node/stream.d.ts:534