InterfaceAuthenticatedRequest

talawa-api • Docs

talawa-api / middleware/isAuth / InterfaceAuthenticatedRequest

Interface: InterfaceAuthenticatedRequest

Extends

Request

Properties

aborted

> aborted: boolean

The message.aborted property will be true if the request has been aborted.

Since

v10.1.0

Deprecated

Since v17.0.0,v16.12.0 - Check message.destroyed from <a href="stream.html#class-streamreadable" class="type">stream.Readable</a>.

Inherited from

Request.aborted

Defined in

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

accepted

> accepted: MediaType[]

Return an array of Accepted media types ordered from highest quality to lowest.

Inherited from

Request.accepted

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:513

app

> app: Application<Record<string, any>>

Inherited from

Request.app

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:659

baseUrl

> baseUrl: string

Inherited from

Request.baseUrl

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:657

body

> body: any

Inherited from

Request.body

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:638

closed

> readonly closed: boolean

Is true after 'close' has been emitted.

Since

v18.0.0

Inherited from

Request.closed

Defined in

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

complete

> complete: boolean

The message.complete property will be true if a complete HTTP message has been received and successfully parsed.

This property is particularly useful as a means of determining if a client or server fully transmitted a message before a connection was terminated:

const req = http.request(\{
  host: '127.0.0.1',
  port: 8080,
  method: 'POST',
\}, (res) =\> \{
  res.resume();
  res.on('end', () =\> \{
    if (!res.complete)
      console.error(
        'The connection was terminated while the message was still being sent');
  \});
\});

Since

v0.3.0

Inherited from

Request.complete

Defined in

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

connection

> connection: Socket

Alias for message.socket.

Since

v0.1.90

Deprecated

Since v16.0.0 - Use socket.

Inherited from

Request.connection

Defined in

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

cookies

> cookies: any

Inherited from

Request.cookies

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:641

destroyed

> destroyed: boolean

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

Since

v8.0.0

Inherited from

Request.destroyed

Defined in

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

errored

> readonly errored: null | Error

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

Since

v18.0.0

Inherited from

Request.errored

Defined in

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

file?

> optional file: File

Multer.File object populated by single() middleware.

Inherited from

Request.file

Defined in

node_modules/@types/multer/index.d.ts:41

files?

> optional files: object | File[]

Array or dictionary of Multer.File object populated by array(), fields(), and any() middleware.

Inherited from

Request.files

Defined in

node_modules/@types/multer/index.d.ts:46

fresh

> fresh: boolean

Check if the request is fresh, aka Last-Modified and/or the ETag still match.

Inherited from

Request.fresh

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:623

headers

> headers: IncomingHttpHeaders

The request/response headers object.

Key-value pairs of header names and values. Header names are lower-cased.

// Prints something like:
//
// \{ 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*' \}
console.log(request.headers);

Duplicates in raw headers are handled in the following ways, depending on the header name:

Duplicates of age, authorization, content-length, content-type, etag, expires, from, host, if-modified-since, if-unmodified-since, last-modified, location, max-forwards, proxy-authorization, referer, retry-after, server, or user-agent are discarded. To allow duplicate values of the headers listed above to be joined, use the option joinDuplicateHeaders in request and createServer. See RFC 9110 Section 5.3 for more information.
set-cookie is always an array. Duplicates are added to the array.
For duplicate cookie headers, the values are joined together with ; .
For all other headers, the values are joined together with , .

Since

v0.1.5

Inherited from

Request.headers

Defined in

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

headersDistinct

> headersDistinct: Dict<string[]>

Similar to message.headers, but there is no join logic and the values are always arrays of strings, even for headers received just once.

// Prints something like:
//
// \{ 'user-agent': ['curl/7.22.0'],
//   host: ['127.0.0.1:8000'],
//   accept: ['*'] \}
console.log(request.headersDistinct);

Since

v18.3.0, v16.17.0

Inherited from

Request.headersDistinct

Defined in

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

host

> host: string

Deprecated

Use hostname instead.

Inherited from

Request.host

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:616

hostname

> hostname: string

Parse the "Host" header field hostname.

Inherited from

Request.hostname

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:611

httpVersion

> httpVersion: string

In case of server request, the HTTP version sent by the client. In the case of client response, the HTTP version of the connected-to server. Probably either '1.1' or '1.0'.

Also message.httpVersionMajor is the first integer and message.httpVersionMinor is the second.

Since

v0.1.1

Inherited from

Request.httpVersion

Defined in

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

httpVersionMajor

> httpVersionMajor: number

Inherited from

Request.httpVersionMajor

Defined in

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

httpVersionMinor

> httpVersionMinor: number

Inherited from

Request.httpVersionMinor

Defined in

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

ip

> ip: undefined | string

Return the remote address, or when "trust proxy" is true return the upstream addr.

Value may be undefined if the req.socket is destroyed (for example, if the client disconnected).

Inherited from

Request.ip

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:578

ips

> ips: string[]

When "trust proxy" is true, parse the "X-Forwarded-For" ip address list.

For example if the value were "client, proxy1, proxy2" you would receive the array ["client", "proxy1", "proxy2"] where "proxy2" is the furthest down-stream.

Inherited from

Request.ips

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:588

isAuth?

> optional isAuth: boolean

Defined in

src/middleware/isAuth.ts:83

locale

> locale: string

Inherited from

Request.locale

Defined in

node_modules/@types/i18n/index.d.ts:456

method

> method: string

Only valid for request obtained from Server.

The request method as a string. Read only. Examples: 'GET', 'DELETE'.

Since

v0.1.1

Inherited from

Request.method

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:643

next?

> optional next: NextFunction

Inherited from

Request.next

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:666

originalUrl

> originalUrl: string

Inherited from

Request.originalUrl

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:653

params

> params: ParamsDictionary

Inherited from

Request.params

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:645

path

> path: string

Short-hand for url.parse(req.url).pathname.

Inherited from

Request.path

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:606

protocol

> protocol: string

Return the protocol string "http" or "https" when requested with TLS. When the "trust proxy" setting is enabled the "X-Forwarded-Proto" header field will be trusted. If you're running behind a reverse proxy that supplies https for you this may be enabled.

Inherited from

Request.protocol

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:561

query

> query: ParsedQs

Inherited from

Request.query

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:647

rawHeaders

> rawHeaders: string[]

The raw request/response headers list exactly as they were received.

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.

Header names are not lowercased, and duplicates are not merged.

// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*' ]
console.log(request.rawHeaders);

Since

v0.11.6

Inherited from

Request.rawHeaders

Defined in

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

rawTrailers

> rawTrailers: string[]

The raw request/response trailer keys and values exactly as they were received. Only populated at the 'end' event.

Since

v0.11.6

Inherited from

Request.rawTrailers

Defined in

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

readable

> readable: boolean

Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

Since

v11.4.0

Inherited from

Request.readable

Defined in

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

readableAborted

> readonly readableAborted: boolean

Experimental

Returns whether the stream was destroyed or errored before emitting 'end'.

Since

v16.8.0

Inherited from

Request.readableAborted

Defined in

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

readableDidRead

> readonly readableDidRead: boolean

Experimental

Returns whether 'data' has been emitted.

Since

v16.7.0, v14.18.0

Inherited from

Request.readableDidRead

Defined in

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

readableEncoding

> readonly readableEncoding: null | BufferEncoding

Getter for the property encoding of a given Readable stream. The encoding property can be set using the setEncoding method.

Since

v12.7.0

Inherited from

Request.readableEncoding

Defined in

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

readableEnded

> readonly readableEnded: boolean

Becomes true when 'end' event is emitted.

Since

v12.9.0

Inherited from

Request.readableEnded

Defined in

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

readableFlowing

> readonly readableFlowing: null | boolean

This property reflects the current state of a Readable stream as described in the Three states section.

Since

v9.4.0

Inherited from

Request.readableFlowing

Defined in

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

readableHighWaterMark

> readonly readableHighWaterMark: number

Returns the value of highWaterMark passed when creating this Readable.

Since

v9.3.0

Inherited from

Request.readableHighWaterMark

Defined in

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

readableLength

> readonly readableLength: number

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

Since

v9.4.0

Inherited from

Request.readableLength

Defined in

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

readableObjectMode

> readonly readableObjectMode: boolean

Getter for the property objectMode of a given Readable stream.

Since

v12.3.0

Inherited from

Request.readableObjectMode

Defined in

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

res?

> optional res: Response<any, Record<string, any>, number>

After middleware.init executed, Request will contain res and next properties See: express/lib/middleware/init.js

Inherited from

Request.res

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:665

route

> route: any

Inherited from

Request.route

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:649

secure

> secure: boolean

Short-hand for:

req.protocol == 'https'

Inherited from

Request.secure

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:568

signedCookies

> signedCookies: any

Inherited from

Request.signedCookies

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:651

socket

> socket: Socket

The net.Socket object associated with the connection.

With HTTPS support, use request.socket.getPeerCertificate() to obtain the client's authentication details.

This property is guaranteed to be an instance of the net.Socket class, a subclass of stream.Duplex, unless the user specified a socket type other than net.Socket or internally nulled.

Since

v0.3.0

Inherited from

Request.socket

Defined in

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

stale

> stale: boolean

Check if the request is stale, aka "Last-Modified" and / or the "ETag" for the resource has changed.

Inherited from

Request.stale

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:630

statusCode?

> optional statusCode: number

Only valid for response obtained from ClientRequest.

The 3-digit HTTP response status code. E.G. 404.

Since

v0.1.1

Inherited from

Request.statusCode

Defined in

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

statusMessage?

> optional statusMessage: string

Only valid for response obtained from ClientRequest.

The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.

Since

v0.11.10

Inherited from

Request.statusMessage

Defined in

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

subdomains

> subdomains: string[]

Return subdomains as an array.

Subdomains are the dot-separated parts of the host before the main domain of the app. By default, the domain of the app is assumed to be the last two parts of the host. This can be changed by setting "subdomain offset".

For example, if the domain is "tobi.ferrets.example.com": If "subdomain offset" is not set, req.subdomains is ["ferrets", "tobi"]. If "subdomain offset" is 3, req.subdomains is ["tobi"].

Inherited from

Request.subdomains

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:601

tokenExpired?

> optional tokenExpired: boolean

Defined in

src/middleware/isAuth.ts:85

trailers

> trailers: Dict<string>

The request/response trailers object. Only populated at the 'end' event.

Since

v0.3.0

Inherited from

Request.trailers

Defined in

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

trailersDistinct

> trailersDistinct: Dict<string[]>

Similar to message.trailers, but there is no join logic and the values are always arrays of strings, even for headers received just once. Only populated at the 'end' event.

Since

v18.3.0, v16.17.0

Inherited from

Request.trailersDistinct

Defined in

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

url

> url: string

Only valid for request obtained from Server.

Request URL string. This contains only the URL that is present in the actual HTTP request. Take the following request:

GET /status?name=ryan HTTP/1.1
Accept: text/plain

To parse the URL into its parts:

new URL(`http://$\{process.env.HOST ?? 'localhost'\}$\{request.url\}`);

When request.url is '/status?name=ryan' and process.env.HOST is undefined:

$ node
\> new URL(`http://$\{process.env.HOST ?? 'localhost'\}$\{request.url\}`);
URL \{
  href: 'http://localhost/status?name=ryan',
  origin: 'http://localhost',
  protocol: 'http:',
  username: '',
  password: '',
  host: 'localhost',
  hostname: 'localhost',
  port: '',
  pathname: '/status',
  search: '?name=ryan',
  searchParams: URLSearchParams \{ 'name' =\> 'ryan' \},
  hash: ''
\}

Ensure that you set process.env.HOST to the server's host name, or consider replacing this part entirely. If using req.headers.host, ensure proper validation is used, as clients may specify a custom Host header.

Since

v0.1.90

Inherited from

Request.url

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:655

userId?

> optional userId: string

Defined in

src/middleware/isAuth.ts:84

xhr

> xhr: boolean

Check if the request was an XMLHttpRequest.

Inherited from

Request.xhr

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:635

Methods

[asyncDispose]()

> [asyncDispose](): Promise<void>

Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

Returns

Promise<void>

Since

v20.4.0

Inherited from

Request.[asyncDispose]

Defined in

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

[asyncIterator]()

> [asyncIterator](): AsyncIterator<any, any, any>

Returns

AsyncIterator<any, any, any>

Inherited from

Request.[asyncIterator]

Defined in

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

[captureRejectionSymbol]()?

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

Type Parameters

• K

Parameters

• error: Error

• event: string | symbol

• ...args: AnyRest

Returns

void

Inherited from

Request.[captureRejectionSymbol]

Defined in

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

__()

__(phraseOrOptions, replace)

> __(phraseOrOptions, ...replace): string

Translate the given phrase using locale configuration

Parameters

• phraseOrOptions: string | TranslateOptions

The phrase to translate or options for translation

• ...replace: string[]

Returns

string

The translated phrase

Inherited from

Request.__

Defined in

node_modules/@types/i18n/index.d.ts:465

__(phraseOrOptions, replacements)

> __(phraseOrOptions, replacements): string

Translate the given phrase using locale configuration

Parameters

• phraseOrOptions: string | TranslateOptions

The phrase to translate or options for translation

• replacements: Replacements

An object containing replacements

Returns

string

The translated phrase

Inherited from

Request.__

Defined in

node_modules/@types/i18n/index.d.ts:472

__h()

> __h(phrase): HashedList[]

Returns a hashed list of translations for a given phrase in each language.

Parameters

• phrase: string

The phrase to get translations in each language

Returns

HashedList[]

The phrase in each language

Inherited from

Request.__h

Defined in

node_modules/@types/i18n/index.d.ts:548

__l()

> __l(phrase): string[]

Returns a list of translations for a given phrase in each language.

Parameters

• phrase: string

The phrase to get translations in each language

Returns

string[]

The phrase in each language

Inherited from

Request.__l

Defined in

node_modules/@types/i18n/index.d.ts:537

__mf()

__mf(phraseOrOptions, replace)

> __mf(phraseOrOptions, ...replace): string

Translate the given phrase using locale configuration and MessageFormat

Parameters

• phraseOrOptions: string | TranslateOptions

The phrase to translate or options for translation

• ...replace: any[]

Returns

string

The translated phrase

Inherited from

Request.__mf

Defined in

node_modules/@types/i18n/index.d.ts:519

__mf(phraseOrOptions, replacements)

> __mf(phraseOrOptions, replacements): string

Translate the given phrase using locale configuration and MessageFormat

Parameters

• phraseOrOptions: string | TranslateOptions

The phrase to translate or options for translation

• replacements: Replacements

An object containing replacements

Returns

string

The translated phrase

Inherited from

Request.__mf

Defined in

node_modules/@types/i18n/index.d.ts:526

__n()

__n(phrase, count)

> __n(phrase, count): string

Translate with plural condition the given phrase and count using locale configuration

Parameters

• phrase: string

Short phrase to be translated. All plural options ("one", "few", other", ...) have to be provided by your translation file

• count: number

The number which allow to select from plural to singular

Returns

string

The translated phrase

Inherited from

Request.__n

Defined in

node_modules/@types/i18n/index.d.ts:484

__n(options, count)

> __n(options, count?): string

Translate with plural condition the given phrase and count using locale configuration

Parameters

• options: PluralOptions

Options for plural translate

• count?: number

The number which allow to select from plural to singular

Returns

string

The translated phrase

Inherited from

Request.__n

Defined in

node_modules/@types/i18n/index.d.ts:492

__n(singular, plural, count)

> __n(singular, plural, count): string

Translate with plural condition the given phrase and count using locale configuration

Parameters

• singular: string

The singular phrase to translate if count is <= 1

• plural: string

The plural phrase to translate if count is > 1

• count: string | number

The number which allow to select from plural to singular

Returns

string

The translated phrase

Inherited from

Request.__n

Defined in

node_modules/@types/i18n/index.d.ts:500

__n(phrase, count, replacements)

> __n(phrase, count, replacements): string

Translate with plural condition the given phrase and count using locale configuration

Parameters

• phrase: string

The phrase to translate or a flattened key path in locale json file

• count: string | number

The number which allow to select from plural to singular

• replacements: Replacements

An object containing replacements

Returns

string

The translated phrase

Inherited from

Request.__n

Defined in

node_modules/@types/i18n/index.d.ts:508

_construct()?

> optional _construct(callback): void

Parameters

• callback

Returns

void

Inherited from

Request._construct

Defined in

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

_destroy()

> _destroy(error, callback): void

Parameters

• error: null | Error

• callback

Returns

void

Inherited from

Request._destroy

Defined in

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

_read()

> _read(size): void

Parameters

• size: number

Returns

void

Inherited from

Request._read

Defined in

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

accepts()

> accepts(): string[]

Check if the given type(s) is acceptable, returning the best match when true, otherwise undefined, in which case you should respond with 406 "Not Acceptable".

The type value may be a single mime type string such as "application/json", the extension name such as "json", a comma-delimted list such as "json, html, text/plain", or an array ["json", "html", "text/plain"]. When a list or array is given the best match, if any is returned.

Examples:

// Accept: text/html req.accepts('html'); // => "html"

// Accept: text/*, application/json req.accepts('html'); // => "html" req.accepts('text/html'); // => "text/html" req.accepts('json, text'); // => "json" req.accepts('application/json'); // => "application/json"

// Accept: text/*, application/json req.accepts('image/png'); req.accepts('png'); // => false

// Accept: text/*;q=.5, application/json req.accepts(['html', 'json']); req.accepts('html, json'); // => "json"

Returns

string[]

Inherited from

Request.accepts

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:454

accepts(type)

> accepts(type): string | false

Parameters

• type: string

Returns

string | false

Inherited from

Request.accepts

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:455

accepts(type)

> accepts(type): string | false

Parameters

• type: string[]

Returns

string | false

Inherited from

Request.accepts

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:456

accepts(type)

> accepts(...type): string | false

Parameters

• ...type: string[]

Returns

string | false

Inherited from

Request.accepts

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:457

acceptsCharsets()

> acceptsCharsets(): string[]

Returns the first accepted charset of the specified character sets, based on the request's Accept-Charset HTTP header field. If none of the specified charsets is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Returns

string[]

Inherited from

Request.acceptsCharsets

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:466

acceptsCharsets(charset)

> acceptsCharsets(charset): string | false

Parameters

• charset: string

Returns

string | false

Inherited from

Request.acceptsCharsets

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:467

acceptsCharsets(charset)

> acceptsCharsets(charset): string | false

Parameters

• charset: string[]

Returns

string | false

Inherited from

Request.acceptsCharsets

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:468

acceptsCharsets(charset)

> acceptsCharsets(...charset): string | false

Parameters

• ...charset: string[]

Returns

string | false

Inherited from

Request.acceptsCharsets

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:469

acceptsEncodings()

> acceptsEncodings(): string[]

Returns the first accepted encoding of the specified encodings, based on the request's Accept-Encoding HTTP header field. If none of the specified encodings is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Returns

string[]

Inherited from

Request.acceptsEncodings

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:478

acceptsEncodings(encoding)

> acceptsEncodings(encoding): string | false

Parameters

• encoding: string

Returns

string | false

Inherited from

Request.acceptsEncodings

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:479

acceptsEncodings(encoding)

> acceptsEncodings(encoding): string | false

Parameters

• encoding: string[]

Returns

string | false

Inherited from

Request.acceptsEncodings

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:480

acceptsEncodings(encoding)

> acceptsEncodings(...encoding): string | false

Parameters

• ...encoding: string[]

Returns

string | false

Inherited from

Request.acceptsEncodings

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:481

acceptsLanguages()

> acceptsLanguages(): string[]

Returns the first accepted language of the specified languages, based on the request's Accept-Language HTTP header field. If none of the specified languages is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Returns

string[]

Inherited from

Request.acceptsLanguages

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:490

acceptsLanguages(lang)

> acceptsLanguages(lang): string | false

Parameters

• lang: string

Returns

string | false

Inherited from

Request.acceptsLanguages

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:491

acceptsLanguages(lang)

> acceptsLanguages(lang): string | false

Parameters

• lang: string[]

Returns

string | false

Inherited from

Request.acceptsLanguages

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:492

acceptsLanguages(lang)

> acceptsLanguages(...lang): string | false

Parameters

• ...lang: string[]

Returns

string | false

Inherited from

Request.acceptsLanguages

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:493

addListener()

addListener(event, listener)

> addListener(event, listener): this

Event emitter The defined events on documents including:

close
data
end
error
pause
readable
resume

Parameters

• event: "close"

• listener

Returns

this

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "data"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "end"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "error"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "pause"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "readable"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: "resume"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

addListener(event, listener)

> addListener(event, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• event: string | symbol

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.addListener

Defined in

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

asIndexedPairs()

> asIndexedPairs(options?): Readable

This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

Parameters

• options?: Pick<ArrayOptions, "signal">

Returns

Readable

a stream of indexed pairs.

Since

v17.5.0

Inherited from

Request.asIndexedPairs

Defined in

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

compose()

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

Type Parameters

• T extends ReadableStream

Parameters

• stream: ComposeFnParam | T | Iterable<T> | AsyncIterable<T>

• options?

• options.signal?: AbortSignal

Returns

T

Inherited from

Request.compose

Defined in

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

destroy()

> destroy(error?): this

Calls destroy() on the socket that received the IncomingMessage. If error is provided, an 'error' event is emitted on the socket and error is passed as an argument to any listeners on the event.

Parameters

• error?: Error

Returns

this

Since

v0.3.0

Inherited from

Request.destroy

Defined in

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

drop()

> drop(limit, options?): Readable

This method returns a new stream with the first limit chunks dropped from the start.

Parameters

• limit: number

the number of chunks to drop from the readable.

• options?: Pick<ArrayOptions, "signal">

Returns

Readable

a stream with limit chunks dropped from the start.

Since

v17.5.0

Inherited from

Request.drop

Defined in

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

emit()

emit(event)

> 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

Request.emit

Defined in

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

emit(event, chunk)

> emit(event, chunk): 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: "data"

• chunk: any

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event)

> 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: "end"

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event, err)

> emit(event, err): 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: "error"

• err: Error

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event)

> 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: "pause"

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event)

> 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: "readable"

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event)

> 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: "resume"

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

emit(event, args)

> emit(event, ...args): 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: string | symbol

• ...args: any[]

Returns

boolean

Since

v0.1.26

Inherited from

Request.emit

Defined in

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

eventNames()

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

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

import \{ EventEmitter \} from 'node:events';

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

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

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

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

Request.eventNames

Defined in

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

every()

> every(fn, options?): Promise<boolean>

This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

Parameters

• fn

a function to call on each chunk of the stream. Async or not.

• options?: ArrayOptions

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for every one of the chunks.

Since

v17.5.0

Inherited from

Request.every

Defined in

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

filter()

> filter(fn, options?): Readable

This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

Parameters

• fn

a function to filter chunks from the stream. Async or not.

• options?: ArrayOptions

Returns

Readable

a stream filtered with the predicate fn.

Since

v17.4.0, v16.14.0

Inherited from

Request.filter

Defined in

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

find()

find(fn, options)

> find<T>(fn, options?): Promise<undefined | T>

This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

Type Parameters

• T

Parameters

• fn

a function to call on each chunk of the stream. Async or not.

• options?: ArrayOptions

Returns

Promise<undefined | T>

a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

Since

v17.5.0

Inherited from

Request.find

Defined in

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

find(fn, options)

> find(fn, options?): Promise<any>

Parameters

• fn

• options?: ArrayOptions

Returns

Promise<any>

Inherited from

Request.find

Defined in

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

flatMap()

> flatMap(fn, options?): Readable

This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

Parameters

• fn

a function to map over every chunk in the stream. May be async. May be a stream or generator.

• options?: ArrayOptions

Returns

Readable

a stream flat-mapped with the function fn.

Since

v17.5.0

Inherited from

Request.flatMap

Defined in

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

forEach()

> forEach(fn, options?): Promise<void>

This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

This method is different from for await...of loops in that it can optionally process chunks concurrently. In addition, a forEach iteration can only be stopped by having passed a signal option and aborting the related AbortController while for await...of can be stopped with break or return. In either case the stream will be destroyed.

This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

Parameters

• fn

a function to call on each chunk of the stream. Async or not.

• options?: ArrayOptions

Returns

Promise<void>

a promise for when the stream has finished.

Since

v17.5.0

Inherited from

Request.forEach

Defined in

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

get()

get(name)

> get(name): undefined | string[]

Return request header.

The Referrer header field is special-cased, both Referrer and Referer are interchangeable.

Examples:

req.get('Content-Type'); // => "text/plain"

req.get('content-type'); // => "text/plain"

req.get('Something'); // => undefined

Aliased as req.header().

Parameters

• name: "set-cookie"

Returns

undefined | string[]

Inherited from

Request.get

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:411

get(name)

> get(name): undefined | string

Parameters

• name: string

Returns

undefined | string

Inherited from

Request.get

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:412

getCatalog()

> getCatalog(): GlobalCatalog

Get the current global catalog

Returns

GlobalCatalog

The current global catalog

Inherited from

Request.getCatalog

Defined in

node_modules/@types/i18n/index.d.ts:568

getCatalog(locale)

> getCatalog(locale?): LocaleCatalog

Get the catalog for the given locale

Parameters

• locale?: string

The locale to get catalog for

Returns

LocaleCatalog

The specified locale catalog

Inherited from

Request.getCatalog

Defined in

node_modules/@types/i18n/index.d.ts:574

getLocale()

> getLocale(): string

Get the current active locale

Returns

string

The current locale in request

Inherited from

Request.getLocale

Defined in

node_modules/@types/i18n/index.d.ts:556

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

Request.getMaxListeners

Defined in

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

header(name)

> header(name): undefined | string[]

Parameters

• name: "set-cookie"

Returns

undefined | string[]

Inherited from

Request.header

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:414

header(name)

> header(name): undefined | string

Parameters

• name: string

Returns

undefined | string

Inherited from

Request.header

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:415

is()

> is(type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8 req.is('html'); req.is('text/html'); req.is('text/*'); // => true

// When Content-Type is application/json req.is('json'); req.is('application/json'); req.is('application/*'); // => true

req.is('html'); // => false

Parameters

• type: string | string[]

Returns

null | string | false

Inherited from

Request.is

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:551

isPaused()

> isPaused(): boolean

The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

const readable = new stream.Readable();

readable.isPaused(); // === false
readable.pause();
readable.isPaused(); // === true
readable.resume();
readable.isPaused(); // === false

Returns

boolean

Since

v0.11.14

Inherited from

Request.isPaused

Defined in

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

iterator()

> iterator(options?): AsyncIterator<any, any, any>

The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

Parameters

• options?

• options.destroyOnReturn?: boolean

When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

Returns

AsyncIterator<any, any, any>

Since

v16.3.0

Inherited from

Request.iterator

Defined in

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

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

• listener?: Function

The event handler function

Returns

number

Since

v3.2.0

Inherited from

Request.listenerCount

Defined in

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

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

Request.listeners

Defined in

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

map()

> map(fn, options?): Readable

This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

Parameters

• fn

a function to map over every chunk in the stream. Async or not.

• options?: ArrayOptions

Returns

Readable

a stream mapped with the function fn.

Since

v17.4.0, v16.14.0

Inherited from

Request.map

Defined in

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

off()

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

Alias for emitter.removeListener().

Type Parameters

• K

Parameters

• eventName: string | symbol

• listener

Returns

this

Since

v10.0.0

Inherited from

Request.off

Defined in

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

on()

on(event, listener)

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

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "data"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "end"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "error"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "pause"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "readable"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: "resume"

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

on(event, listener)

> on(event, listener): this

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

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

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: string | symbol

• listener

The callback function

Returns

this

Since

v0.1.101

Inherited from

Request.on

Defined in

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

once()

once(event, listener)

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

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "data"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "end"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "error"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "pause"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "readable"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: "resume"

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

once(event, listener)

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

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: string | symbol

• listener

The callback function

Returns

this

Since

v0.3.0

Inherited from

Request.once

Defined in

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

param()

> param(name, defaultValue?): string

Parameters

• name: string

• defaultValue?: any

Returns

string

Deprecated

since 4.11 Use either req.params, req.body or req.query, as applicable.

Return the value of param name when present or defaultValue.

Checks route placeholders, ex: /user/:id
Checks body params, ex: id=12, {"id":12}
Checks query string params, ex: ?id=12

To utilize request bodies, req.body should be an object. This can be done by using the connect.bodyParser() middleware.

Inherited from

Request.param

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:528

pause()

> pause(): this

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

const readable = getReadableStreamSomehow();
readable.on('data', (chunk) =\> \{
  console.log(`Received $\{chunk.length\} bytes of data.`);
  readable.pause();
  console.log('There will be no additional data for 1 second.');
  setTimeout(() =\> \{
    console.log('Now data will start flowing again.');
    readable.resume();
  \}, 1000);
\});

The readable.pause() method has no effect if there is a 'readable' event listener.

Returns

this

Since

v0.9.4

Inherited from

Request.pause

Defined in

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

pipe()

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

Type Parameters

• T extends WritableStream

Parameters

• destination: T

• options?

• options.end?: boolean

Returns

T

Inherited from

Request.pipe

Defined in

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

prependListener()

prependListener(event, listener)

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

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "data"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "end"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "error"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "pause"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "readable"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: "resume"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependListener(event, listener)

> prependListener(event, listener): this

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

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

Parameters

• event: string | symbol

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependListener

Defined in

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

prependOnceListener()

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "close"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "data"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "end"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "error"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "pause"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "readable"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: "resume"

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

prependOnceListener(event, listener)

> prependOnceListener(event, listener): this

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

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

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

Parameters

• event: string | symbol

• listener

The callback function

Returns

this

Since

v6.0.0

Inherited from

Request.prependOnceListener

Defined in

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

push()

> push(chunk, encoding?): boolean

Parameters

• chunk: any

• encoding?: BufferEncoding

Returns

boolean

Inherited from

Request.push

Defined in

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

range()

> range(size, options?): undefined | Ranges | Result

Parse Range header field, capping to the given size.

Unspecified ranges such as "0-" require knowledge of your resource length. In the case of a byte range this is of course the total number of bytes. If the Range header field is not given undefined is returned. If the Range header field is given, return value is a result of range-parser. See more ./types/range-parser/index.d.ts

NOTE: remember that ranges are inclusive, so for example "Range: users=0-3" should respond with 4 users when available, not 3.

Parameters

• size: number

• options?: Options

Returns

undefined | Ranges | Result

Inherited from

Request.range

Defined in

node_modules/@types/express-serve-static-core/index.d.ts:507

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

Request.rawListeners

Defined in

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

read()

> read(size?): any

The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating in object mode.

The optional size argument specifies a specific number of bytes to read. If size bytes are not available to be read, null will be returned unless the stream has ended, in which case all of the data remaining in the internal buffer will be returned.

If the size argument is not specified, all of the data contained in the internal buffer will be returned.

The size argument must be less than or equal to 1 GiB.

The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

const readable = getReadableStreamSomehow();

// 'readable' may be triggered multiple times as data is buffered in
readable.on('readable', () =\> \{
  let chunk;
  console.log('Stream is readable (new data received in buffer)');
  // Use a loop to make sure we read all currently available data
  while (null !== (chunk = readable.read())) \{
    console.log(`Read $\{chunk.length\} bytes of data...`);
  \}
\});

// 'end' will be triggered once when there is no more data available
readable.on('end', () =\> \{
  console.log('Reached end of stream.');
\});

Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, having consumed all buffered content so far, but there is still more data to come not yet buffered. In this case a new 'readable' event will be emitted when there is more data in the buffer. Finally the 'end' event will be emitted when there is no more data to come.

Therefore to read a file's whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

const chunks = [];

readable.on('readable', () =\> \{
  let chunk;
  while (null !== (chunk = readable.read())) \{
    chunks.push(chunk);
  \}
\});

readable.on('end', () =\> \{
  const content = chunks.join('');
\});

A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of the size argument.

If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

Parameters

• size?: number

Optional argument to specify how much data to read.

Returns

any

Since

v0.9.4

Inherited from

Request.read

Defined in

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

reduce()

reduce(fn, initial, options)

> reduce<T>(fn, initial?, options?): Promise<T>

This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

Type Parameters

• T = any

Parameters

• fn

a reducer function to call over every chunk in the stream. Async or not.

• initial?: undefined

the initial value to use in the reduction.

• options?: Pick<ArrayOptions, "signal">

Returns

Promise<T>

a promise for the final value of the reduction.

Since

v17.5.0

Inherited from

Request.reduce

Defined in

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

reduce(fn, initial, options)

> reduce<T>(fn, initial, options?): Promise<T>

Type Parameters

• T = any

Parameters

• fn

• initial: T

• options?: Pick<ArrayOptions, "signal">

Returns

Promise<T>

Inherited from

Request.reduce

Defined in

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

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

• eventName?: string | symbol

Returns

this

Since

v0.1.26

Inherited from

Request.removeAllListeners

Defined in

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

removeListener()

removeListener(event, listener)

> 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 fromemit() in progress. Subsequent events behave as expected.

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

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

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

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

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

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

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

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

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

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

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

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

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

Parameters

• event: "close"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "data"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "end"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "error"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "pause"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "readable"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: "resume"

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

removeListener(event, listener)

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

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

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: string | symbol

• listener

Returns

this

Since

v0.1.26

Inherited from

Request.removeListener

Defined in

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

resume()

> resume(): this

The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

getReadableStreamSomehow()
  .resume()
  .on('end', () =\> \{
    console.log('Reached the end, but did not read anything.');
  \});

The readable.resume() method has no effect if there is a 'readable' event listener.

Returns

this

Since

v0.9.4

Inherited from

Request.resume

Defined in

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

setEncoding()

> setEncoding(encoding): this

The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the output data to be interpreted as UTF-8 data, and passed as strings. Calling readable.setEncoding('hex') will cause the data to be encoded in hexadecimal string format.

The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.

const readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) =\> \{
  assert.equal(typeof chunk, 'string');
  console.log('Got %d characters of string data:', chunk.length);
\});

Parameters

• encoding: BufferEncoding

The encoding to use.

Returns

this

Since

v0.9.4

Inherited from

Request.setEncoding

Defined in

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

setLocale()

> setLocale(locale): void

Change the current active locale

Parameters

• locale: string

The locale to set as default

Returns

void

Inherited from

Request.setLocale

Defined in

node_modules/@types/i18n/index.d.ts:562

setMaxListeners()

> setMaxListeners(n): this

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set 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

Request.setMaxListeners

Defined in

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

setTimeout()

> setTimeout(msecs, callback?): this

Calls message.socket.setTimeout(msecs, callback).

Parameters

• msecs: number

• callback?

Returns

this

Since

v0.5.9

Inherited from

Request.setTimeout

Defined in

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

some()

> some(fn, options?): Promise<boolean>

This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

Parameters

• fn

a function to call on each chunk of the stream. Async or not.

• options?: ArrayOptions

Returns

Promise<boolean>

a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

Since

v17.5.0

Inherited from

Request.some

Defined in

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

take()

> take(limit, options?): Readable

This method returns a new stream with the first limit chunks.

Parameters

• limit: number

the number of chunks to take from the readable.

• options?: Pick<ArrayOptions, "signal">

Returns

Readable

a stream with limit chunks taken.

Since

v17.5.0

Inherited from

Request.take

Defined in

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

toArray()

> toArray(options?): Promise<any[]>

This method allows easily obtaining the contents of a stream.

As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

Parameters

• options?: Pick<ArrayOptions, "signal">

Returns

Promise<any[]>

a promise containing an array with the contents of the stream.

Since

v17.5.0

Inherited from

Request.toArray

Defined in

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

unpipe()

> unpipe(destination?): this

The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

If the destination is not specified, then all pipes are detached.

If the destination is specified, but no pipe is set up for it, then the method does nothing.

import fs from 'node:fs';
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() =\> \{
  console.log('Stop writing to file.txt.');
  readable.unpipe(writable);
  console.log('Manually close the file stream.');
  writable.end();
\}, 1000);

Parameters

• destination?: WritableStream

Optional specific stream to unpipe

Returns

this

Since

v0.9.4

Inherited from

Request.unpipe

Defined in

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

unshift()

> unshift(chunk, encoding?): void

Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be flushed.

The readable.unshift() method pushes a chunk of data back into the internal buffer. This is useful in certain situations where a stream is being consumed by code that needs to "un-consume" some amount of data that it has optimistically pulled out of the source, so that the data can be passed on to some other party.

The stream.unshift(chunk) method cannot be called after the 'end' event has been emitted or a runtime error will be thrown.

Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

// Pull off a header delimited by \n\n.
// Use unshift() if we get too much.
// Call the callback with (error, header, stream).
import \{ StringDecoder \} from 'node:string_decoder';
function parseHeader(stream, callback) \{
  stream.on('error', callback);
  stream.on('readable', onReadable);
  const decoder = new StringDecoder('utf8');
  let header = '';
  function onReadable() \{
    let chunk;
    while (null !== (chunk = stream.read())) \{
      const str = decoder.write(chunk);
      if (str.includes('\n\n')) \{
        // Found the header boundary.
        const split = str.split(/\n\n/);
        header += split.shift();
        const remaining = split.join('\n\n');
        const buf = Buffer.from(remaining, 'utf8');
        stream.removeListener('error', callback);
        // Remove the 'readable' listener before unshifting.
        stream.removeListener('readable', onReadable);
        if (buf.length)
          stream.unshift(buf);
        // Now the body of the message can be read from the stream.
        callback(null, header, stream);
        return;
      \}
      // Still reading the header.
      header += str;
    \}
  \}
\}

Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. This can cause unexpected results if readable.unshift() is called during a read (i.e. from within a _read implementation on a custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, however it is best to simply avoid calling readable.unshift() while in the process of performing a read.

Parameters

• chunk: any

Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

• encoding?: BufferEncoding

Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

Returns

void

Since

v0.9.11

Inherited from

Request.unshift

Defined in

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

wrap()

> wrap(stream): this

Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable stream that uses the old stream as its data source.

It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

import \{ OldReader \} from './old-api-module.js';
import \{ Readable \} from 'node:stream';
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () =\> \{
  myReader.read(); // etc.
\});

Parameters

• stream: ReadableStream

An "old style" readable stream

Returns

this

Since

v0.9.4

Inherited from

Request.wrap

Defined in

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

Interface: InterfaceAuthenticatedRequest

Extends​

Properties​

aborted​

Since​

Deprecated​

Inherited from​

Defined in​

accepted​

Inherited from​

Defined in​

app​

Inherited from​

Defined in​

baseUrl​

Inherited from​

Defined in​

body​

Inherited from​

Defined in​

closed​

Since​

Inherited from​

Defined in​

complete​

Since​

Inherited from​

Defined in​

connection​

Since​

Deprecated​

Inherited from​

Defined in​

cookies​

Inherited from​

Defined in​

destroyed​

Since​

Inherited from​

Defined in​

errored​

Since​

Inherited from​

Defined in​

file?​

Inherited from​

Defined in​

files?​

Inherited from​

Defined in​

fresh​

Inherited from​

Defined in​

headers​

Since​

Inherited from​

Defined in​

headersDistinct​

Since​

Inherited from​

Defined in​

host​

Deprecated​

Inherited from​

Defined in​

hostname​

Inherited from​

Defined in​

httpVersion​

Since​

Inherited from​

Defined in​

httpVersionMajor​

Inherited from​

Defined in​

httpVersionMinor​

Inherited from​

Defined in​

ip​

Inherited from​

Extends

Properties

aborted

Since

Deprecated

Inherited from

Defined in

accepted

Inherited from

Defined in

app

Inherited from

Defined in

baseUrl

Inherited from

Defined in

body

Inherited from

Defined in

closed

Since

Inherited from

Defined in

complete

Since

Inherited from

Defined in

connection

Since

Deprecated

Inherited from

Defined in

cookies

Inherited from

Defined in

destroyed

Since

Inherited from

Defined in

errored

Since

Inherited from

Defined in

file?

Inherited from

Defined in

files?

Inherited from

Defined in

fresh

Inherited from

Defined in

headers

Since

Inherited from

Defined in

headersDistinct

Since

Inherited from

Defined in

host

Deprecated

Inherited from

Defined in

hostname

Inherited from

Defined in

httpVersion

Since

Inherited from

Defined in

httpVersionMajor

Inherited from

Defined in

httpVersionMinor

Inherited from

Defined in

ip

Inherited from

Defined in