# Class ServerResponse<Request>

This object is created internally by an HTTP server, not by the user. It is passed as the second parameter to the `'request'` event.

#### Since

v0.1.17

#### Type Parameters

- Request extends IncomingMessage = IncomingMessage

#### Hierarchy (view full)

- OutgoingMessage<Request>
  - ServerResponse

- Defined in node_modules/@types/node/http.d.ts:703

#####
Index

### Constructors

constructor

### Properties

chunkedEncoding
closed
connection
destroyed
errored
finished
headersSent
req
sendDate
shouldKeepAlive
socket
statusCode
statusMessage
strictContentLength
useChunkedEncodingByDefault
writable
writableCorked
writableEnded
writableFinished
writableHighWaterMark
writableLength
writableNeedDrain
writableObjectMode
captureRejectionSymbol
captureRejections
defaultMaxListeners
errorMonitor

### Methods

[captureRejectionSymbol]?
_construct?
_destroy
_final
_write
_writev?
addListener
addTrailers
appendHeader
assignSocket
compose
cork
destroy
detachSocket
emit
end
eventNames
flushHeaders
getHeader
getHeaderNames
getHeaders
getMaxListeners
hasHeader
listenerCount
listeners
off
on
once
pipe
prependListener
prependOnceListener
rawListeners
removeAllListeners
removeHeader
removeListener
setDefaultEncoding
setHeader
setMaxListeners
setTimeout
uncork
write
writeContinue
writeEarlyHints
writeHead
writeProcessing
addAbortListener
fromWeb
getEventListeners
getMaxListeners
listenerCount
on
once
setMaxListeners
toWeb

## Constructors

### constructor

- new ServerResponse<Request>(req): ServerResponse<Request>

- #### Type Parameters

  - Request extends IncomingMessage = IncomingMessage

  #### Parameters

  - req: Request

  #### Returns ServerResponse<Request>

  Overrides OutgoingMessage.constructor

  - Defined in node_modules/@types/node/http.d.ts:740

## Properties

### chunkedEncoding

chunkedEncoding: boolean

Inherited from OutgoingMessage.chunkedEncoding

- Defined in node_modules/@types/node/http.d.ts:548

### `Readonly` closed

closed: boolean

Is `true` after `'close'` has been emitted.

#### Since

v18.0.0

Inherited from OutgoingMessage.closed

- Defined in node_modules/@types/node/stream.d.ts:712

### `Readonly` connection

connection: null | Socket

Alias of `outgoingMessage.socket`.

#### Since

v0.3.0

#### Deprecated

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

Inherited from OutgoingMessage.connection

- Defined in node_modules/@types/node/http.d.ts:566

### destroyed

destroyed: boolean

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

#### Since

v8.0.0

Inherited from OutgoingMessage.destroyed

- Defined in node_modules/@types/node/stream.d.ts:707

### `Readonly` errored

errored: null | Error

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

#### Since

v18.0.0

Inherited from OutgoingMessage.errored

- Defined in node_modules/@types/node/stream.d.ts:717

### finished

finished: boolean

#### Deprecated

Use `writableEnded` instead.

Inherited from OutgoingMessage.finished

- Defined in node_modules/@types/node/http.d.ts:555

### `Readonly` headersSent

headersSent: boolean

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

#### Since

v0.9.3

Inherited from OutgoingMessage.headersSent

- Defined in node_modules/@types/node/http.d.ts:560

### `Readonly` req

req: Request

Inherited from OutgoingMessage.req

- Defined in node_modules/@types/node/http.d.ts:547

### sendDate

sendDate: boolean

Inherited from OutgoingMessage.sendDate

- Defined in node_modules/@types/node/http.d.ts:551

### shouldKeepAlive

shouldKeepAlive: boolean

Inherited from OutgoingMessage.shouldKeepAlive

- Defined in node_modules/@types/node/http.d.ts:549

### `Readonly` socket

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 OutgoingMessage.socket

- Defined in node_modules/@types/node/http.d.ts:574

### 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

- Defined in node_modules/@types/node/http.d.ts:717

### 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

- Defined in node_modules/@types/node/http.d.ts:732

### 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

- Defined in node_modules/@types/node/http.d.ts:739

### useChunkedEncodingByDefault

useChunkedEncodingByDefault: boolean

Inherited from OutgoingMessage.useChunkedEncodingByDefault

- Defined in node_modules/@types/node/http.d.ts:550

### `Readonly` writable

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 OutgoingMessage.writable

- Defined in node_modules/@types/node/stream.d.ts:668

### `Readonly` writableCorked

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 OutgoingMessage.writableCorked

- Defined in node_modules/@types/node/stream.d.ts:702

### `Readonly` writableEnded

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 OutgoingMessage.writableEnded

- Defined in node_modules/@types/node/stream.d.ts:674

### `Readonly` writableFinished

writableFinished: boolean

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

#### Since

v12.6.0

Inherited from OutgoingMessage.writableFinished

- Defined in node_modules/@types/node/stream.d.ts:679

### `Readonly` writableHighWaterMark

writableHighWaterMark: number

Return the value of `highWaterMark` passed when creating this `Writable`.

#### Since

v9.3.0

Inherited from OutgoingMessage.writableHighWaterMark

- Defined in node_modules/@types/node/stream.d.ts:684

### `Readonly` writableLength

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 OutgoingMessage.writableLength

- Defined in node_modules/@types/node/stream.d.ts:691

### `Readonly` writableNeedDrain

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 OutgoingMessage.writableNeedDrain

- Defined in node_modules/@types/node/stream.d.ts:722

### `Readonly` writableObjectMode

writableObjectMode: boolean

Getter for the property `objectMode` of a given `Writable` stream.

#### Since

v12.3.0

Inherited from OutgoingMessage.writableObjectMode

- Defined in node_modules/@types/node/stream.d.ts:696

### `Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

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

See how to write a custom `rejection handler`.

#### Since

v13.4.0, v12.16.0

Inherited from OutgoingMessage.captureRejectionSymbol

- Defined in node_modules/@types/node/events.d.ts:430

### `Static` captureRejections

captureRejections: boolean

Value: boolean

Change the default `captureRejections` option on all new `EventEmitter` objects.

#### Since

v13.4.0, v12.16.0

Inherited from OutgoingMessage.captureRejections

- Defined in node_modules/@types/node/events.d.ts:437

### `Static` defaultMaxListeners

defaultMaxListeners: number

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

Take caution when setting the `events.defaultMaxListeners` because the change affects all `EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`.

This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any single `EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()` methods can be used to temporarily avoid this warning:

    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.setMaxListeners(emitter.getMaxListeners() + 1);
    emitter.once('event', () => {
      // do stuff
      emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
    });

The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.

#### Since

v0.11.2

Inherited from OutgoingMessage.defaultMaxListeners

- Defined in node_modules/@types/node/events.d.ts:476

### `Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

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

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

#### Since

v13.6.0, v12.17.0

Inherited from OutgoingMessage.errorMonitor

- Defined in node_modules/@types/node/events.d.ts:423

## Methods

### `Optional` [captureRejectionSymbol]

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

- #### Type Parameters

  - K

  #### Parameters

  - error: Error
  - event: string | symbol
  - `Rest` ...args: AnyRest

  #### Returns void

  Inherited from OutgoingMessage.[captureRejectionSymbol]

  - Defined in node_modules/@types/node/events.d.ts:135

### `Optional` _construct

- _construct(callback): void

- #### Parameters

  - callback: ((error?) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: null | Error

        #### Returns void

  Inherited from OutgoingMessage._construct

  - Defined in node_modules/@types/node/stream.d.ts:732

### _destroy

- _destroy(error, callback): void

- #### Parameters

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

      - #### Parameters

        - `Optional` error: null | Error

        #### Returns void

  Inherited from OutgoingMessage._destroy

  - Defined in node_modules/@types/node/stream.d.ts:733

### _final

- _final(callback): void

- #### Parameters

  - callback: ((error?) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: null | Error

        #### Returns void

  Inherited from OutgoingMessage._final

  - Defined in node_modules/@types/node/stream.d.ts:734

### _write

- _write(chunk, encoding, callback): void

- #### Parameters

  - chunk: any
  - encoding: BufferEncoding
  - callback: ((error?) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: null | Error

        #### Returns void

  Inherited from OutgoingMessage._write

  - Defined in node_modules/@types/node/stream.d.ts:724

### `Optional` _writev

- _writev(chunks, callback): void

- #### Parameters

  - chunks: {
    chunk: any;
    encoding: BufferEncoding;
    }[]
  - callback: ((error?) => void)
    - - (error?): void

      - #### Parameters

        - `Optional` error: null | Error

        #### Returns void

  Inherited from OutgoingMessage._writev

  - Defined in node_modules/@types/node/stream.d.ts:725

### addListener

- addListener(event, listener): this

- Event emitter The defined events on documents including:

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

  #### Parameters

  - event: "close"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:900
- addListener(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:901
- addListener(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:902
- addListener(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:903
- addListener(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:904
- addListener(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:905
- addListener(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.addListener

  - Defined in node_modules/@types/node/stream.d.ts:906

### addTrailers

- addTrailers(headers): void

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

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

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

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

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

  #### Parameters

  - headers: OutgoingHttpHeaders | readonly [string, string][]

  #### Returns void

  #### Since

  v0.3.0

  Inherited from OutgoingMessage.addTrailers

  - Defined in node_modules/@types/node/http.d.ts:683

### appendHeader

- appendHeader(name, value): this

- Append a single header value to the header object.

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

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

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

  #### Parameters

  - name: string

    Header name

  - value: string | readonly string[]

    Header value

  #### Returns this

  #### Since

  v18.3.0, v16.17.0

  Inherited from OutgoingMessage.appendHeader

  - Defined in node_modules/@types/node/http.d.ts:606

### assignSocket

- assignSocket(socket): void

- #### Parameters

  - socket: Socket

  #### Returns void

  - Defined in node_modules/@types/node/http.d.ts:741

### compose

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

- #### Type Parameters

  - T extends ReadableStream

  #### Parameters

  - stream: ComposeFnParam | T | Iterable<T> | AsyncIterable<T>
  - `Optional` options: {
    signal: AbortSignal;
    }

    - ##### signal: AbortSignal

  #### Returns T

  Inherited from OutgoingMessage.compose

  - Defined in node_modules/@types/node/stream.d.ts:36

### 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 implementing `writable._writev()` may have an adverse effect on throughput.

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

  #### Returns void

  #### Since

  v0.11.2

  Inherited from OutgoingMessage.cork

  - Defined in node_modules/@types/node/stream.d.ts:838

### destroy

- destroy(error?): this

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

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

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

  #### Parameters

  - `Optional` error: Error

    Optional, an error to emit with `'error'` event.

  #### Returns this

  #### Since

  v8.0.0

  Inherited from OutgoingMessage.destroy

  - Defined in node_modules/@types/node/stream.d.ts:889

### detachSocket

- detachSocket(socket): void

- #### Parameters

  - socket: Socket

  #### Returns void

  - Defined in node_modules/@types/node/http.d.ts:742

### emit

- emit(event): boolean

- Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments to each.

  Returns `true` if the event had listeners, `false` otherwise.

      import { EventEmitter } from 'node:events';
      const myEmitter = new EventEmitter();

      // First listener
      myEmitter.on('event', function firstListener() {
        console.log('Helloooo! first listener');
      });
      // Second listener
      myEmitter.on('event', function secondListener(arg1, arg2) {
        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
      });
      // Third listener
      myEmitter.on('event', function thirdListener(...args) {
        const parameters = args.join(', ');
        console.log(`event with parameters ${parameters} in third listener`);
      });

      console.log(myEmitter.listeners('event'));

      myEmitter.emit('event', 1, 2, 3, 4, 5);

      // Prints:
      // [
      //   [Function: firstListener],
      //   [Function: secondListener],
      //   [Function: thirdListener]
      // ]
      // Helloooo! first listener
      // event with parameters 1, 2 in second listener
      // event with parameters 1, 2, 3, 4, 5 in third listener

  #### Parameters

  - event: "close"

  #### Returns boolean

  #### Since

  v0.1.26

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:907
- emit(event): boolean

- #### Parameters

  - event: "drain"

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:908
- emit(event, err): boolean

- #### Parameters

  - event: "error"
  - err: Error

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:909
- emit(event): boolean

- #### Parameters

  - event: "finish"

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:910
- emit(event, src): boolean

- #### Parameters

  - event: "pipe"
  - src: Readable

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:911
- emit(event, src): boolean

- #### Parameters

  - event: "unpipe"
  - src: Readable

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:912
- emit(event, ...args): boolean

- #### Parameters

  - event: string | symbol
  - `Rest` ...args: any[]

  #### Returns boolean

  Inherited from OutgoingMessage.emit

  - Defined in node_modules/@types/node/stream.d.ts:913

### end

- end(cb?): this

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

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

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

  #### Parameters

  - `Optional` cb: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v0.9.4

  Inherited from OutgoingMessage.end

  - Defined in node_modules/@types/node/stream.d.ts:821
- end(chunk, cb?): this

- #### Parameters

  - chunk: any
  - `Optional` cb: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.end

  - Defined in node_modules/@types/node/stream.d.ts:822
- end(chunk, encoding, cb?): this

- #### Parameters

  - chunk: any
  - encoding: BufferEncoding
  - `Optional` cb: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.end

  - Defined in node_modules/@types/node/stream.d.ts:823

### 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.

      import { EventEmitter } from 'node:events';

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

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

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

  #### Returns (string | symbol)[]

  #### Since

  v6.0.0

  Inherited from OutgoingMessage.eventNames

  - Defined in node_modules/@types/node/events.d.ts:900

### flushHeaders

- flushHeaders(): void

- Flushes the message headers.

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

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

  #### Returns void

  #### Since

  v1.6.0

  Inherited from OutgoingMessage.flushHeaders

  - Defined in node_modules/@types/node/http.d.ts:696

### getHeader

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

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

  #### Parameters

  - name: string

    Name of header

  #### Returns undefined | string | number | string[]

  #### Since

  v0.4.0

  Inherited from OutgoingMessage.getHeader

  - Defined in node_modules/@types/node/http.d.ts:613

### getHeaderNames

- getHeaderNames(): string[]

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

  #### Returns string[]

  #### Since

  v7.7.0

  Inherited from OutgoingMessage.getHeaderNames

  - Defined in node_modules/@types/node/http.d.ts:641

### getHeaders

- getHeaders(): OutgoingHttpHeaders

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

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

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

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

  #### Returns OutgoingHttpHeaders

  #### Since

  v7.7.0

  Inherited from OutgoingMessage.getHeaders

  - Defined in node_modules/@types/node/http.d.ts:635

### getMaxListeners

- getMaxListeners(): number

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

  #### Returns number

  #### Since

  v1.0.0

  Inherited from OutgoingMessage.getMaxListeners

  - Defined in node_modules/@types/node/events.d.ts:752

### hasHeader

- hasHeader(name): boolean

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

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

  #### Parameters

  - name: string

  #### Returns boolean

  #### Since

  v7.7.0

  Inherited from OutgoingMessage.hasHeader

  - Defined in node_modules/@types/node/http.d.ts:651

### listenerCount

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

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

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol

    The name of the event being listened for

  - `Optional` listener: Function

    The event handler function

  #### Returns number

  #### Since

  v3.2.0

  Inherited from OutgoingMessage.listenerCount

  - Defined in node_modules/@types/node/events.d.ts:846

### listeners

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

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

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

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol

  #### Returns Function[]

  #### Since

  v0.1.26

  Inherited from OutgoingMessage.listeners

  - Defined in node_modules/@types/node/events.d.ts:765

### off

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

- Alias for `emitter.removeListener()`.

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v10.0.0

  Inherited from OutgoingMessage.off

  - Defined in node_modules/@types/node/events.d.ts:725

### on

- on(event, listener): this

- Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName` and `listener` will result in the `listener` being added, and called, multiple times.

      server.on('connection', (stream) => {
        console.log('someone connected!');
      });

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

  By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.on('foo', () => console.log('a'));
      myEE.prependListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

  #### Parameters

  - event: "close"

    The name of the event.

  - listener: (() => void)

    The callback function

    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v0.1.101

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:914
- on(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:915
- on(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:916
- on(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:917
- on(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:918
- on(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:919
- on(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/stream.d.ts:920

### once

- once(event, listener): this

- Adds a one-time `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked.

      server.once('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });

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

  By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.once('foo', () => console.log('a'));
      myEE.prependOnceListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

  #### Parameters

  - event: "close"

    The name of the event.

  - listener: (() => void)

    The callback function

    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v0.3.0

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:921
- once(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:922
- once(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:923
- once(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:924
- once(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:925
- once(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:926
- once(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/stream.d.ts:927

### pipe

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

- #### Type Parameters

  - T extends WritableStream

  #### Parameters

  - destination: T
  - `Optional` options: {
    end?: boolean;
    }

    - ##### `Optional` end?: boolean

  #### Returns T

  Inherited from OutgoingMessage.pipe

  - Defined in node_modules/@types/node/stream.d.ts:30

### prependListener

- prependListener(event, listener): this

- Adds the `listener` function to the beginning of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName` and `listener` will result in the `listener` being added, and called, multiple times.

      server.prependListener('connection', (stream) => {
        console.log('someone connected!');
      });

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

  #### Parameters

  - event: "close"

    The name of the event.

  - listener: (() => void)

    The callback function

    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v6.0.0

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:928
- prependListener(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:929
- prependListener(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:930
- prependListener(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:931
- prependListener(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:932
- prependListener(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:933
- prependListener(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependListener

  - Defined in node_modules/@types/node/stream.d.ts:934

### prependOnceListener

- prependOnceListener(event, listener): this

- Adds a one-time `listener` function for the event named `eventName` to the beginning of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked.

      server.prependOnceListener('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });

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

  #### Parameters

  - event: "close"

    The name of the event.

  - listener: (() => void)

    The callback function

    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v6.0.0

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:935
- prependOnceListener(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:936
- prependOnceListener(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:937
- prependOnceListener(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:938
- prependOnceListener(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:939
- prependOnceListener(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:940
- prependOnceListener(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.prependOnceListener

  - Defined in node_modules/@types/node/stream.d.ts:941

### rawListeners

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

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

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

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

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

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

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

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

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol

  #### Returns Function[]

  #### Since

  v9.4.0

  Inherited from OutgoingMessage.rawListeners

  - Defined in node_modules/@types/node/events.d.ts:796

### removeAllListeners

- removeAllListeners(eventName?): this

- Removes all listeners, or those of the specified `eventName`.

  It is bad practice to remove listeners added elsewhere in the code, particularly when the `EventEmitter` instance was created by some other component or module (e.g. sockets or file streams).

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

  #### Parameters

  - `Optional` eventName: string | symbol

  #### Returns this

  #### Since

  v0.1.26

  Inherited from OutgoingMessage.removeAllListeners

  - Defined in node_modules/@types/node/events.d.ts:736

### removeHeader

- removeHeader(name): void

- Removes a header that is queued for implicit sending.

      outgoingMessage.removeHeader('Content-Encoding');

  #### Parameters

  - name: string

    Header name

  #### Returns void

  #### Since

  v0.4.0

  Inherited from OutgoingMessage.removeHeader

  - Defined in node_modules/@types/node/http.d.ts:661

### removeListener

- removeListener(event, listener): this

- Removes the specified `listener` from the listener array for the event named `eventName`.

      const callback = (stream) => {
        console.log('someone connected!');
      };
      server.on('connection', callback);
      // ...
      server.removeListener('connection', callback);

  `removeListener()` will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified `eventName`, then `removeListener()` must be called multiple times to remove each instance.

  Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any `removeListener()` or `removeAllListeners()` calls after emitting and before the last listener finishes execution will not remove them from`emit()` in progress. Subsequent events behave as expected.

      import { EventEmitter } from 'node:events';
      class MyEmitter extends EventEmitter {}
      const myEmitter = new MyEmitter();

      const callbackA = () => {
        console.log('A');
        myEmitter.removeListener('event', callbackB);
      };

      const callbackB = () => {
        console.log('B');
      };

      myEmitter.on('event', callbackA);

      myEmitter.on('event', callbackB);

      // callbackA removes listener callbackB but it will still be called.
      // Internal listener array at time of emit [callbackA, callbackB]
      myEmitter.emit('event');
      // Prints:
      //   A
      //   B

      // callbackB is now removed.
      // Internal listener array [callbackA]
      myEmitter.emit('event');
      // Prints:
      //   A

  Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the `emitter.listeners()` method will need to be recreated.

  When a single function has been added as a handler multiple times for a single event (as in the example below), `removeListener()` will remove the most recently added instance. In the example the `once('ping')` listener is removed:

      import { EventEmitter } from 'node:events';
      const ee = new EventEmitter();

      function pong() {
        console.log('pong');
      }

      ee.on('ping', pong);
      ee.once('ping', pong);
      ee.removeListener('ping', pong);

      ee.emit('ping');
      ee.emit('ping');

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

  #### Parameters

  - event: "close"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v0.1.26

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:942
- removeListener(event, listener): this

- #### Parameters

  - event: "drain"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:943
- removeListener(event, listener): this

- #### Parameters

  - event: "error"
  - listener: ((err) => void)
    - - (err): void

      - #### Parameters

        - err: Error

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:944
- removeListener(event, listener): this

- #### Parameters

  - event: "finish"
  - listener: (() => void)
    - - (): void

      - #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:945
- removeListener(event, listener): this

- #### Parameters

  - event: "pipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:946
- removeListener(event, listener): this

- #### Parameters

  - event: "unpipe"
  - listener: ((src) => void)
    - - (src): void

      - #### Parameters

        - src: Readable

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:947
- removeListener(event, listener): this

- #### Parameters

  - event: string | symbol
  - listener: ((...args) => void)
    - - (...args): void

      - #### Parameters

        - `Rest` ...args: any[]

        #### Returns void

  #### Returns this

  Inherited from OutgoingMessage.removeListener

  - Defined in node_modules/@types/node/stream.d.ts:948

### setDefaultEncoding

- setDefaultEncoding(encoding): this

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

  #### Parameters

  - encoding: BufferEncoding

    The new default encoding

  #### Returns this

  #### Since

  v0.11.15

  Inherited from OutgoingMessage.setDefaultEncoding

  - Defined in node_modules/@types/node/stream.d.ts:798

### setHeader

- setHeader(name, value): this

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

  #### Parameters

  - name: string

    Header name

  - value: string | number | readonly string[]

    Header value

  #### Returns this

  #### Since

  v0.4.0

  Inherited from OutgoingMessage.setHeader

  - Defined in node_modules/@types/node/http.d.ts:590

### setMaxListeners

- setMaxListeners(n): this

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

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

  #### Parameters

  - n: number

  #### Returns this

  #### Since

  v0.3.5

  Inherited from OutgoingMessage.setMaxListeners

  - Defined in node_modules/@types/node/events.d.ts:746

### setTimeout

- setTimeout(msecs, callback?): this

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

  #### Parameters

  - msecs: number
  - `Optional` callback: (() => void)

    Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.

    - - (): void

      - #### Returns void

  #### Returns this

  #### Since

  v0.9.12

  Inherited from OutgoingMessage.setTimeout

  - Defined in node_modules/@types/node/http.d.ts:581

### 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()` using `process.nextTick()`. Doing so allows batching of all `writable.write()` calls that occur within a given Node.js event loop phase.

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

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

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

  See also: `writable.cork()`.

  #### Returns void

  #### Since

  v0.11.2

  Inherited from OutgoingMessage.uncork

  - Defined in node_modules/@types/node/stream.d.ts:872

### 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 the `highWaterMark` configured when the stream was created after admitting `chunk`. If `false` is returned, further attempts to write data to the stream should stop until the `'drain'` event is emitted.

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

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

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

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

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

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

  #### Parameters

  - chunk: any

    Optional data to write. For streams not operating in object mode, `chunk` must be a {string}, {Buffer}, {TypedArray} or {DataView}. For object mode streams, `chunk` may be any JavaScript value other than `null`.

  - `Optional` callback: ((error) => void)

    Callback for when this chunk of data is flushed.

    - - (error): void

      - #### Parameters

        - error: undefined | null | Error

        #### Returns void

  #### Returns boolean

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

  #### Since

  v0.9.4

  Inherited from OutgoingMessage.write

  - Defined in node_modules/@types/node/stream.d.ts:791
- write(chunk, encoding, callback?): boolean

- #### Parameters

  - chunk: any
  - encoding: BufferEncoding
  - `Optional` callback: ((error) => void)
    - - (error): void

      - #### Parameters

        - error: undefined | null | Error

        #### Returns void

  #### Returns boolean

  Inherited from OutgoingMessage.write

  - Defined in node_modules/@types/node/stream.d.ts:792

### 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 on `Server`.

  #### Parameters

  - `Optional` callback: (() => void)
    - - (): void

      - #### Returns void

  #### Since

  v0.3.0

  - Defined in node_modules/@types/node/http.d.ts:748

### writeEarlyHints

- writeEarlyHints(hints, callback?): void

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

  Example

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

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

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

  #### Parameters

  - hints: Record<string, string | string[]>

    An object containing the values of headers

  - `Optional` callback: (() => void)

    Will be called when the response message has been written

    - - (): void

      - #### Returns void

  #### Since

  v18.11.0

  - Defined in node_modules/@types/node/http.d.ts:782

### writeHead

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

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

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

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

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

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

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

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

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

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

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

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

  #### Parameters

  - statusCode: number
  - `Optional` statusMessage: string
  - `Optional` headers: OutgoingHttpHeaders | OutgoingHttpHeader[]

  #### Returns this

  #### Since

  v0.1.30

  - Defined in node_modules/@types/node/http.d.ts:840
- writeHead(statusCode, headers?): this

- #### Parameters

  - statusCode: number
  - `Optional` headers: OutgoingHttpHeaders | OutgoingHttpHeader[]

  #### Returns this

  - Defined in node_modules/@types/node/http.d.ts:845

### writeProcessing

- writeProcessing(): void

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

  #### Returns void

  #### Since

  v10.0.0

  - Defined in node_modules/@types/node/http.d.ts:851

### `Static` addAbortListener

- addAbortListener(signal, resource): Disposable
- `Experimental`

  Listens once to the `abort` event on the provided `signal`.

  Listening to the `abort` event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call `e.stopImmediatePropagation()`. Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

  This API allows safely using `AbortSignal`s in Node.js APIs by solving these two issues by listening to the event such that `stopImmediatePropagation` does not prevent the listener from running.

  Returns a disposable so that it may be unsubscribed from more easily.

      import { addAbortListener } from 'node:events';

      function example(signal) {
        let disposable;
        try {
          signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
          disposable = addAbortListener(signal, (e) => {
            // Do something when signal is aborted.
          });
        } finally {
          disposable?.[Symbol.dispose]();
        }
      }

  #### Parameters

  - signal: AbortSignal
  - resource: ((event) => void)
    - - (event): void

      - #### Parameters

        - event: Event

        #### Returns void

  #### Returns Disposable

  Disposable that removes the `abort` listener.

  #### Since

  v20.5.0

  Inherited from OutgoingMessage.addAbortListener

  - Defined in node_modules/@types/node/events.d.ts:415

### `Static` fromWeb

- fromWeb(writableStream, options?): Writable
- `Experimental`

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

  #### Parameters

  - writableStream: WritableStream<any>
  - `Optional` options: Pick<WritableOptions, "signal" | "highWaterMark" | "objectMode" | "decodeStrings">

  #### Returns Writable

  #### Since

  v17.0.0

  Inherited from OutgoingMessage.fromWeb

  - Defined in node_modules/@types/node/stream.d.ts:1014

### `Static` getEventListeners

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

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

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

  #### Parameters

  - emitter: EventEmitter<DefaultEventMap> | EventTarget
  - name: string | symbol

  #### Returns Function[]

  #### Since

  v15.2.0, v14.17.0

  Inherited from OutgoingMessage.getEventListeners

  - Defined in node_modules/@types/node/events.d.ts:336

### `Static` getMaxListeners

- getMaxListeners(emitter): number

- Returns the currently set max amount of listeners.

  For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on the emitter.

  For `EventTarget`s this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

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

      {
        const ee = new EventEmitter();
        console.log(getMaxListeners(ee)); // 10
        setMaxListeners(11, ee);
        console.log(getMaxListeners(ee)); // 11
      }
      {
        const et = new EventTarget();
        console.log(getMaxListeners(et)); // 10
        setMaxListeners(11, et);
        console.log(getMaxListeners(et)); // 11
      }

  #### Parameters

  - emitter: EventEmitter<DefaultEventMap> | EventTarget

  #### Returns number

  #### Since

  v19.9.0

  Inherited from OutgoingMessage.getMaxListeners

  - Defined in node_modules/@types/node/events.d.ts:365

### `Static` listenerCount

- listenerCount(emitter, eventName): number

- A class method that returns the number of listeners for the given `eventName` registered on the given `emitter`.

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

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

  #### Parameters

  - emitter: EventEmitter<DefaultEventMap>

    The emitter to query

  - eventName: string | symbol

    The event name

  #### Returns number

  #### Since

  v0.9.12

  #### Deprecated

  Since v3.2.0 - Use `listenerCount` instead.

  Inherited from OutgoingMessage.listenerCount

  - Defined in node_modules/@types/node/events.d.ts:308

### `Static` on

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

-     import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here

  Returns an `AsyncIterator` that iterates `eventName` events. It will throw if the `EventEmitter` emits `'error'`. It removes all listeners when exiting the loop. The `value` returned by each iteration is an array composed of the emitted event arguments.

  An `AbortSignal` can be used to cancel waiting on events:

      import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ac = new AbortController();

      (async () => {
        const ee = new EventEmitter();

        // Emit later on
        process.nextTick(() => {
          ee.emit('foo', 'bar');
          ee.emit('foo', 42);
        });

        for await (const event of on(ee, 'foo', { signal: ac.signal })) {
          // The execution of this inner block is synchronous and it
          // processes one event at a time (even with await). Do not use
          // if concurrent execution is required.
          console.log(event); // prints ['bar'] [42]
        }
        // Unreachable here
      })();

      process.nextTick(() => ac.abort());

  #### Parameters

  - emitter: EventEmitter<DefaultEventMap>
  - eventName: string | symbol

    The name of the event being listened for

  - `Optional` options: StaticEventEmitterOptions

  #### Returns AsyncIterableIterator<any>

  An `AsyncIterator` that iterates `eventName` events emitted by the `emitter`

  #### Since

  v13.6.0, v12.16.0

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/events.d.ts:281
- on(emitter, eventName, options?): AsyncIterableIterator<any>

- #### Parameters

  - emitter: EventTarget
  - eventName: string
  - `Optional` options: StaticEventEmitterOptions

  #### Returns AsyncIterableIterator<any>

  Inherited from OutgoingMessage.on

  - Defined in node_modules/@types/node/events.d.ts:286

### `Static` once

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

- Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. The `Promise` will resolve with an array of all the arguments emitted to the given event.

  This method is intentionally generic and works with the web platform EventTarget interface, which has no special`'error'` event semantics and does not listen to the `'error'` event.

      import { once, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.error('error happened', err);
      }

  The special handling of the `'error'` event is only used when `events.once()` is used to wait for another event. If `events.once()` is used to wait for the '`error'` event itself, then it is treated as any other kind of event without special handling:

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

      const ee = new EventEmitter();

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

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

      // Prints: ok boom

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

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

      const ee = new EventEmitter();
      const ac = new AbortController();

      async function foo(emitter, event, signal) {
        try {
          await once(emitter, event, { signal });
          console.log('event emitted!');
        } catch (error) {
          if (error.name === 'AbortError') {
            console.error('Waiting for the event was canceled!');
          } else {
            console.error('There was an error', error.message);
          }
        }
      }

      foo(ee, 'foo', ac.signal);
      ac.abort(); // Abort waiting for the event
      ee.emit('foo'); // Prints: Waiting for the event was canceled!

  #### Parameters

  - emitter: EventEmitter<DefaultEventMap>
  - eventName: string | symbol
  - `Optional` options: Pick<StaticEventEmitterOptions, "signal">

  #### Returns Promise<any[]>

  #### Since

  v11.13.0, v10.16.0

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/events.d.ts:216
- once(emitter, eventName, options?): Promise<any[]>

- #### Parameters

  - emitter: EventTarget
  - eventName: string
  - `Optional` options: StaticEventEmitterOptions

  #### Returns Promise<any[]>

  Inherited from OutgoingMessage.once

  - Defined in node_modules/@types/node/events.d.ts:221

### `Static` setMaxListeners

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

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

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

      setMaxListeners(5, target, emitter);

  #### Parameters

  - `Optional` n: number

    A non-negative number. The maximum number of listeners per `EventTarget` event.

  - `Rest` ...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

  #### Returns void

  #### Since

  v15.4.0

  Inherited from OutgoingMessage.setMaxListeners

  - Defined in node_modules/@types/node/events.d.ts:380

### `Static` toWeb

- toWeb(streamWritable): WritableStream<any>
- `Experimental`

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

  #### Parameters

  - streamWritable: Writable

  #### Returns WritableStream<any>

  #### Since

  v17.0.0

  Inherited from OutgoingMessage.toWeb

  - Defined in node_modules/@types/node/stream.d.ts:1023