RequestWithSession

@accounts/rest-express › Globals › RequestWithSession

Type parameters

▪ P: core.Params

▪ ResBody

▪ ReqBody

▪ ReqQuery

Hierarchy

• Request

  ↳ RequestWithSession

Implements

• ReadableStream

Index

Constructors

• constructor

Properties

• aborted
• accepted
• app
• baseUrl
• body
• complete
• connection
• cookies
• destroyed
• fresh
• headers
• host
• hostname
• httpVersion
• httpVersionMajor
• httpVersionMinor
• infos
• ip
• ips
• method
• next
• originalUrl
• params
• path
• protocol
• query
• rawHeaders
• rawTrailers
• readable
• readableEncoding
• readableEnded
• readableHighWaterMark
• readableLength
• readableObjectMode
• res
• route
• secure
• session
• signedCookies
• socket
• stale
• statusCode
• statusMessage
• subdomains
• trailers
• url
• userAgent
• xhr

Methods

• [Symbol.asyncIterator]
• _destroy
• _read
• accepts
• acceptsCharsets
• acceptsEncodings
• acceptsLanguages
• addListener
• destroy
• emit
• eventNames
• get
• getMaxListeners
• header
• is
• isPaused
• listenerCount
• listeners
• off
• on
• once
• param
• pause
• pipe
• prependListener
• prependOnceListener
• push
• range
• rawListeners
• read
• removeAllListeners
• removeListener
• resume
• setEncoding
• setMaxListeners
• setTimeout
• unpipe
• unshift
• wrap
• from

Constructors

constructor

+ new RequestWithSession(socket: Socket): RequestWithSession

Inherited from RequestWithSession.constructor

Overrides void

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

Parameters:

Name	Type
socket	Socket

Returns: RequestWithSession

Properties

aborted

• aborted: boolean

Inherited from RequestWithSession.aborted

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

---

accepted

• accepted: MediaType[]

Inherited from RequestWithSession.accepted

Defined in node_modules/@types/express-serve-static-core/index.d.ts:343

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

---

app

• app: Application

Inherited from RequestWithSession.app

Defined in node_modules/@types/express-serve-static-core/index.d.ts:486

---

baseUrl

• baseUrl: string

Inherited from RequestWithSession.baseUrl

Defined in node_modules/@types/express-serve-static-core/index.d.ts:484

---

body

• body: ReqBody

Inherited from RequestWithSession.body

Defined in node_modules/@types/express-serve-static-core/index.d.ts:465

---

complete

• complete: boolean

Inherited from RequestWithSession.complete

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

---

connection

• connection: Socket

Inherited from RequestWithSession.connection

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

deprecate Use socket instead.

---

cookies

• cookies: any

Inherited from RequestWithSession.cookies

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

---

destroyed

• destroyed: boolean

Inherited from RequestWithSession.destroyed

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

---

fresh

• fresh: boolean

Inherited from RequestWithSession.fresh

Defined in node_modules/@types/express-serve-static-core/index.d.ts:450

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

---

headers

• headers: IncomingHttpHeaders

Inherited from RequestWithSession.headers

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

---

host

• host: string

Inherited from RequestWithSession.host

Defined in node_modules/@types/express-serve-static-core/index.d.ts:443

deprecated Use hostname instead.

---

hostname

• hostname: string

Inherited from RequestWithSession.hostname

Defined in node_modules/@types/express-serve-static-core/index.d.ts:438

Parse the "Host" header field hostname.

---

httpVersion

• httpVersion: string

Inherited from RequestWithSession.httpVersion

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

---

httpVersionMajor

• httpVersionMajor: number

Inherited from RequestWithSession.httpVersionMajor

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

---

httpVersionMinor

• httpVersionMinor: number

Inherited from RequestWithSession.httpVersionMinor

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

---

infos

• infos: object

Inherited from RequestWithSession.infos

Defined in packages/rest-express/src/custom.d.ts:5

Type declaration:

• ip: string

• userAgent: string

---

ip

• ip: string

Inherited from RequestWithSession.ip

Overrides void

Defined in node_modules/@types/express-serve-static-core/index.d.ts:405

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

---

ips

• ips: string[]

Inherited from RequestWithSession.ips

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

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.

---

method

• method: string

Inherited from RequestWithSession.method

Overrides void

Defined in node_modules/@types/express-serve-static-core/index.d.ts:470

---

Optional next

• next? : NextFunction

Inherited from RequestWithSession.next

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

---

originalUrl

• originalUrl: string

Inherited from RequestWithSession.originalUrl

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

---

params

• params: P

Inherited from RequestWithSession.params

Defined in node_modules/@types/express-serve-static-core/index.d.ts:472

---

path

• path: string

Inherited from RequestWithSession.path

Defined in node_modules/@types/express-serve-static-core/index.d.ts:433

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

---

protocol

• protocol: string

Inherited from RequestWithSession.protocol

Defined in node_modules/@types/express-serve-static-core/index.d.ts:391

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.

---

query

• query: ReqQuery

Inherited from RequestWithSession.query

Defined in node_modules/@types/express-serve-static-core/index.d.ts:474

---

rawHeaders

• rawHeaders: string[]

Inherited from RequestWithSession.rawHeaders

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

---

rawTrailers

• rawTrailers: string[]

Inherited from RequestWithSession.rawTrailers

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

---

readable

• readable: boolean

Inherited from RequestWithSession.readable

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

---

Readonly readableEncoding

• readableEncoding: BufferEncoding | null

Inherited from RequestWithSession.readableEncoding

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

---

Readonly readableEnded

• readableEnded: boolean

Inherited from RequestWithSession.readableEnded

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

---

Readonly readableHighWaterMark

• readableHighWaterMark: number

Inherited from RequestWithSession.readableHighWaterMark

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

---

Readonly readableLength

• readableLength: number

Inherited from RequestWithSession.readableLength

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

---

Readonly readableObjectMode

• readableObjectMode: boolean

Inherited from RequestWithSession.readableObjectMode

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

---

Optional res

• res? : Response‹ResBody›

Inherited from RequestWithSession.res

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

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

---

route

• route: any

Inherited from RequestWithSession.route

Defined in node_modules/@types/express-serve-static-core/index.d.ts:476

---

secure

• secure: boolean

Inherited from RequestWithSession.secure

Defined in node_modules/@types/express-serve-static-core/index.d.ts:398

Short-hand for:

req.protocol == 'https'

---

session

• session: any

Defined in packages/rest-express/src/endpoints/oauth/provider-callback.ts:7

---

signedCookies

• signedCookies: any

Inherited from RequestWithSession.signedCookies

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

---

socket

• socket: Socket

Inherited from RequestWithSession.socket

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

---

stale

• stale: boolean

Inherited from RequestWithSession.stale

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

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

---

Optional statusCode

• statusCode? : number

Inherited from RequestWithSession.statusCode

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

Only valid for response obtained from http.ClientRequest.

---

Optional statusMessage

• statusMessage? : string

Inherited from RequestWithSession.statusMessage

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

Only valid for response obtained from http.ClientRequest.

---

subdomains

• subdomains: string[]

Inherited from RequestWithSession.subdomains

Defined in node_modules/@types/express-serve-static-core/index.d.ts:428

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

---

trailers

• trailers: Dict‹string›

Inherited from RequestWithSession.trailers

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

---

url

• url: string

Inherited from RequestWithSession.url

Overrides void

Defined in node_modules/@types/express-serve-static-core/index.d.ts:482

---

userAgent

• userAgent: string

Inherited from RequestWithSession.userAgent

Defined in packages/rest-express/src/custom.d.ts:3

---

xhr

• xhr: boolean

Inherited from RequestWithSession.xhr

Defined in node_modules/@types/express-serve-static-core/index.d.ts:462

Check if the request was an XMLHttpRequest.

Methods

[Symbol.asyncIterator]

▸ [Symbol.asyncIterator](): AsyncIterableIterator‹any›

Inherited from RequestWithSession.[Symbol.asyncIterator]

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

Returns: AsyncIterableIterator‹any›

---

_destroy

▸ _destroy(error: Error | null, callback: function): void

Inherited from RequestWithSession._destroy

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

Parameters:

▪ error: Error | null

▪ callback: function

▸ (error?: Error | null): void

Parameters:

Name	Type
error?	Error | null

Returns: void

---

_read

▸ _read(size: number): void

Inherited from RequestWithSession._read

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

Parameters:

Name	Type
size	number

Returns: void

---

accepts

▸ accepts(): string[]

Inherited from RequestWithSession.accepts

Defined in node_modules/@types/express-serve-static-core/index.d.ts:283

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

// => undefined

// Accept: text/*;q=.5, application/json

req.accepts(['html', 'json']);

req.accepts('html, json');

// => "json"

Returns: string[]

▸ accepts(type: string): string | false

Inherited from RequestWithSession.accepts

Defined in node_modules/@types/express-serve-static-core/index.d.ts:284

Parameters:

Name	Type
type	string

Returns: string | false

▸ accepts(type: string[]): string | false

Inherited from RequestWithSession.accepts

Defined in node_modules/@types/express-serve-static-core/index.d.ts:285

Parameters:

Name	Type
type	string[]

Returns: string | false

▸ accepts(...type: string[]): string | false

Inherited from RequestWithSession.accepts

Defined in node_modules/@types/express-serve-static-core/index.d.ts:286

Parameters:

Name	Type
...type	string[]

Returns: string | false

---

acceptsCharsets

▸ acceptsCharsets(): string[]

Inherited from RequestWithSession.acceptsCharsets

Defined in node_modules/@types/express-serve-static-core/index.d.ts:295

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[]

▸ acceptsCharsets(charset: string): string | false

Inherited from RequestWithSession.acceptsCharsets

Defined in node_modules/@types/express-serve-static-core/index.d.ts:296

Parameters:

Name	Type
charset	string

Returns: string | false

▸ acceptsCharsets(charset: string[]): string | false

Inherited from RequestWithSession.acceptsCharsets

Defined in node_modules/@types/express-serve-static-core/index.d.ts:297

Parameters:

Name	Type
charset	string[]

Returns: string | false

▸ acceptsCharsets(...charset: string[]): string | false

Inherited from RequestWithSession.acceptsCharsets

Defined in node_modules/@types/express-serve-static-core/index.d.ts:298

Parameters:

Name	Type
...charset	string[]

Returns: string | false

---

acceptsEncodings

▸ acceptsEncodings(): string[]

Inherited from RequestWithSession.acceptsEncodings

Defined in node_modules/@types/express-serve-static-core/index.d.ts:307

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[]

▸ acceptsEncodings(encoding: string): string | false

Inherited from RequestWithSession.acceptsEncodings

Defined in node_modules/@types/express-serve-static-core/index.d.ts:308

Parameters:

Name	Type
encoding	string

Returns: string | false

▸ acceptsEncodings(encoding: string[]): string | false

Inherited from RequestWithSession.acceptsEncodings

Defined in node_modules/@types/express-serve-static-core/index.d.ts:309

Parameters:

Name	Type
encoding	string[]

Returns: string | false

▸ acceptsEncodings(...encoding: string[]): string | false

Inherited from RequestWithSession.acceptsEncodings

Defined in node_modules/@types/express-serve-static-core/index.d.ts:310

Parameters:

Name	Type
...encoding	string[]

Returns: string | false

---

acceptsLanguages

▸ acceptsLanguages(): string[]

Inherited from RequestWithSession.acceptsLanguages

Defined in node_modules/@types/express-serve-static-core/index.d.ts:319

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[]

▸ acceptsLanguages(lang: string): string | false

Inherited from RequestWithSession.acceptsLanguages

Defined in node_modules/@types/express-serve-static-core/index.d.ts:320

Parameters:

Name	Type
lang	string

Returns: string | false

▸ acceptsLanguages(lang: string[]): string | false

Inherited from RequestWithSession.acceptsLanguages

Defined in node_modules/@types/express-serve-static-core/index.d.ts:321

Parameters:

Name	Type
lang	string[]

Returns: string | false

▸ acceptsLanguages(...lang: string[]): string | false

Inherited from RequestWithSession.acceptsLanguages

Defined in node_modules/@types/express-serve-static-core/index.d.ts:322

Parameters:

Name	Type
...lang	string[]

Returns: string | false

---

addListener

▸ addListener(event: "close", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Event emitter The defined events on documents including:

1. close
2. data
3. end
4. error
5. pause
6. readable
7. resume

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ addListener(event: "data", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ addListener(event: "end", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ addListener(event: "error", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ addListener(event: "pause", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ addListener(event: "readable", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ addListener(event: "resume", listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ addListener(event: string | symbol, listener: function): this

Inherited from RequestWithSession.addListener

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

destroy

▸ destroy(error?: Error): void

Inherited from RequestWithSession.destroy

Overrides void

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

Parameters:

Name	Type
error?	Error

Returns: void

---

emit

▸ emit(event: "close"): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"close"

Returns: boolean

▸ emit(event: "data", chunk: any): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"data"
chunk	any

Returns: boolean

▸ emit(event: "end"): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"end"

Returns: boolean

▸ emit(event: "error", err: Error): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"error"
err	Error

Returns: boolean

▸ emit(event: "pause"): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"pause"

Returns: boolean

▸ emit(event: "readable"): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"readable"

Returns: boolean

▸ emit(event: "resume"): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

Name	Type
event	"resume"

Returns: boolean

▸ emit(event: string | symbol, ...args: any[]): boolean

Inherited from RequestWithSession.emit

Overrides void

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

Parameters:

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

Returns: boolean

---

eventNames

▸ eventNames(): Array‹string | symbol›

Inherited from RequestWithSession.eventNames

Defined in node_modules/@types/node/globals.d.ts:568

Returns: Array‹string | symbol›

---

get

▸ get(name: "set-cookie"): string[] | undefined

Inherited from RequestWithSession.get

Defined in node_modules/@types/express-serve-static-core/index.d.ts:240

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	Type
name	"set-cookie"

Returns: string[] | undefined

▸ get(name: string): string | undefined

Inherited from RequestWithSession.get

Defined in node_modules/@types/express-serve-static-core/index.d.ts:241

Parameters:

Name	Type
name	string

Returns: string | undefined

---

getMaxListeners

▸ getMaxListeners(): number

Inherited from RequestWithSession.getMaxListeners

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

Returns: number

---

header

▸ header(name: "set-cookie"): string[] | undefined

Inherited from RequestWithSession.header

Defined in node_modules/@types/express-serve-static-core/index.d.ts:243

Parameters:

Name	Type
name	"set-cookie"

Returns: string[] | undefined

▸ header(name: string): string | undefined

Inherited from RequestWithSession.header

Defined in node_modules/@types/express-serve-static-core/index.d.ts:244

Parameters:

Name	Type
name	string

Returns: string | undefined

---

is

▸ is(type: string | string[]): string | false | null

Inherited from RequestWithSession.is

Defined in node_modules/@types/express-serve-static-core/index.d.ts:381

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:

Name	Type
type	string | string[]

Returns: string | false | null

---

isPaused

▸ isPaused(): boolean

Inherited from RequestWithSession.isPaused

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

Returns: boolean

---

listenerCount

▸ listenerCount(type: string | symbol): number

Inherited from RequestWithSession.listenerCount

Defined in node_modules/@types/node/globals.d.ts:564

Parameters:

Name	Type
type	string | symbol

Returns: number

---

listeners

▸ listeners(event: string | symbol): Function[]

Inherited from RequestWithSession.listeners

Defined in node_modules/@types/node/globals.d.ts:561

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

off

▸ off(event: string | symbol, listener: function): this

Inherited from RequestWithSession.off

Defined in node_modules/@types/node/globals.d.ts:557

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

on

▸ on(event: "close", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "data", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ on(event: "end", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "error", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ on(event: "pause", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "readable", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: "resume", listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ on(event: string | symbol, listener: function): this

Inherited from RequestWithSession.on

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

once

▸ once(event: "close", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "data", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ once(event: "end", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "error", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ once(event: "pause", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "readable", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: "resume", listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ once(event: string | symbol, listener: function): this

Inherited from RequestWithSession.once

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

param

▸ param(name: string, defaultValue?: any): string

Inherited from RequestWithSession.param

Defined in node_modules/@types/express-serve-static-core/index.d.ts:358

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.

Parameters:

Name	Type
name	string
defaultValue?	any

Returns: string

---

pause

▸ pause(): this

Inherited from RequestWithSession.pause

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

Returns: this

---

pipe

▸ pipe‹T›(destination: T, options?: object): T

Inherited from RequestWithSession.pipe

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

Type parameters:

▪ T: WritableStream

Parameters:

▪ destination: T

▪Optional options: object

Name	Type
end?	boolean

Returns: T

---

prependListener

▸ prependListener(event: "close", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ prependListener(event: "data", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ prependListener(event: "end", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ prependListener(event: "error", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ prependListener(event: "pause", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ prependListener(event: "readable", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ prependListener(event: "resume", listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ prependListener(event: string | symbol, listener: function): this

Inherited from RequestWithSession.prependListener

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

prependOnceListener

▸ prependOnceListener(event: "close", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ prependOnceListener(event: "data", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ prependOnceListener(event: "end", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ prependOnceListener(event: "error", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ prependOnceListener(event: "pause", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ prependOnceListener(event: "readable", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ prependOnceListener(event: "resume", listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ prependOnceListener(event: string | symbol, listener: function): this

Inherited from RequestWithSession.prependOnceListener

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

push

▸ push(chunk: any, encoding?: BufferEncoding): boolean

Inherited from RequestWithSession.push

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

Parameters:

Name	Type
chunk	any
encoding?	BufferEncoding

Returns: boolean

---

range

▸ range(size: number, options?: RangeParserOptions): RangeParserRanges | RangeParserResult | undefined

Inherited from RequestWithSession.range

Defined in node_modules/@types/express-serve-static-core/index.d.ts:337

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:

Name	Type
size	number
options?	RangeParserOptions

Returns: RangeParserRanges | RangeParserResult | undefined

---

rawListeners

▸ rawListeners(event: string | symbol): Function[]

Inherited from RequestWithSession.rawListeners

Defined in node_modules/@types/node/globals.d.ts:562

Parameters:

Name	Type
event	string | symbol

Returns: Function[]

---

read

▸ read(size?: number): any

Inherited from RequestWithSession.read

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

Parameters:

Name	Type
size?	number

Returns: any

---

removeAllListeners

▸ removeAllListeners(event?: string | symbol): this

Inherited from RequestWithSession.removeAllListeners

Defined in node_modules/@types/node/globals.d.ts:558

Parameters:

Name	Type
event?	string | symbol

Returns: this

---

removeListener

▸ removeListener(event: "close", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "close"

▪ listener: function

▸ (): void

Returns: this

▸ removeListener(event: "data", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "data"

▪ listener: function

▸ (chunk: any): void

Parameters:

Name	Type
chunk	any

Returns: this

▸ removeListener(event: "end", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "end"

▪ listener: function

▸ (): void

Returns: this

▸ removeListener(event: "error", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "error"

▪ listener: function

▸ (err: Error): void

Parameters:

Name	Type
err	Error

Returns: this

▸ removeListener(event: "pause", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "pause"

▪ listener: function

▸ (): void

Returns: this

▸ removeListener(event: "readable", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "readable"

▪ listener: function

▸ (): void

Returns: this

▸ removeListener(event: "resume", listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: "resume"

▪ listener: function

▸ (): void

Returns: this

▸ removeListener(event: string | symbol, listener: function): this

Inherited from RequestWithSession.removeListener

Overrides void

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

Parameters:

▪ event: string | symbol

▪ listener: function

▸ (...args: any[]): void

Parameters:

Name	Type
...args	any[]

Returns: this

---

resume

▸ resume(): this

Inherited from RequestWithSession.resume

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

Returns: this

---

setEncoding

▸ setEncoding(encoding: BufferEncoding): this

Inherited from RequestWithSession.setEncoding

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

Parameters:

Name	Type
encoding	BufferEncoding

Returns: this

---

setMaxListeners

▸ setMaxListeners(n: number): this

Inherited from RequestWithSession.setMaxListeners

Defined in node_modules/@types/node/globals.d.ts:559

Parameters:

Name	Type
n	number

Returns: this

---

setTimeout

▸ setTimeout(msecs: number, callback?: function): this

Inherited from RequestWithSession.setTimeout

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

Parameters:

▪ msecs: number

▪Optional callback: function

▸ (): void

Returns: this

---

unpipe

▸ unpipe(destination?: WritableStream): this

Inherited from RequestWithSession.unpipe

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

Parameters:

Name	Type
destination?	WritableStream

Returns: this

---

unshift

▸ unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from RequestWithSession.unshift

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

Parameters:

Name	Type
chunk	any
encoding?	BufferEncoding

Returns: void

---

wrap

▸ wrap(oldStream: ReadableStream): this

Inherited from RequestWithSession.wrap

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

Parameters:

Name	Type
oldStream	ReadableStream

Returns: this

---

Static from

▸ from(iterable: Iterable‹any› | AsyncIterable‹any›, options?: ReadableOptions): Readable

Inherited from RequestWithSession.from

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

A utility method for creating Readable Streams out of iterators.

Parameters:

Name	Type
iterable	Iterable‹any› | AsyncIterable‹any›
options?	ReadableOptions

Returns: Readable