RequestWithSession
@accounts/rest-express › Globals › RequestWithSession
Type parameters
▪ P
▪ ResBody
▪ ReqBody
▪ ReqQuery
▪ Locals: Record‹string, any›
Hierarchy
Request
↳ RequestWithSession
Implements
- ReadableStream
Index
Constructors
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
- readableAborted
- readableDidRead
- readableEncoding
- readableEnded
- readableFlowing
- readableHighWaterMark
- readableLength
- readableObjectMode
- res
- route
- secure
- session
- signedCookies
- socket
- stale
- statusCode
- statusMessage
- subdomains
- trailers
- url
- userAgent
- xhr
Methods
- [Symbol.asyncIterator]
- _construct
- _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
- isDisturbed
Constructors
constructor
+ new RequestWithSession(socket
: Socket): RequestWithSession
Inherited from RequestWithSession.constructor
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:759
Parameters:
Name | Type |
---|---|
socket | Socket |
Returns: RequestWithSession
Properties
aborted
• aborted: boolean
Inherited from RequestWithSession.aborted
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:766
The message.aborted
property will be true
if the request has
been aborted.
since
v10.1.0
accepted
• accepted: MediaType[]
Inherited from RequestWithSession.accepted
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:499
Return an array of Accepted media types ordered from highest quality to lowest.
app
• app: Application
Inherited from RequestWithSession.app
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:642
baseUrl
• baseUrl: string
Inherited from RequestWithSession.baseUrl
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:640
body
• body: ReqBody
Inherited from RequestWithSession.body
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:621
complete
• complete: boolean
Inherited from RequestWithSession.complete
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:801
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
connection
• connection: Socket
Inherited from RequestWithSession.connection
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:807
Alias for message.socket
.
since
v0.1.90
deprecated
Since v16.0.0 - Use socket
.
cookies
• cookies: any
Inherited from RequestWithSession.cookies
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:624
destroyed
• destroyed: boolean
Inherited from RequestWithSession.destroyed
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:115
Is true
after readable.destroy()
has been called.
since
v8.0.0
fresh
• fresh: boolean
Inherited from RequestWithSession.fresh
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:606
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:844
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
, oruser-agent
are discarded. 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
host
• host: string
Inherited from RequestWithSession.host
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:599
deprecated
Use hostname instead.
hostname
• hostname: string
Inherited from RequestWithSession.hostname
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:594
Parse the "Host" header field hostname.
httpVersion
• httpVersion: string
Inherited from RequestWithSession.httpVersion
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:775
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 andmessage.httpVersionMinor
is the second.
since
v0.1.1
httpVersionMajor
• httpVersionMajor: number
Inherited from RequestWithSession.httpVersionMajor
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:776
httpVersionMinor
• httpVersionMinor: number
Inherited from RequestWithSession.httpVersionMinor
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:777
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:561
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:571
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:626
Optional
next
• next? : NextFunction | undefined
Inherited from RequestWithSession.next
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:649
originalUrl
• originalUrl: string
Inherited from RequestWithSession.originalUrl
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:636
params
• params: P
Inherited from RequestWithSession.params
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:628
path
• path: string
Inherited from RequestWithSession.path
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:589
Short-hand for url.parse(req.url).pathname
.
protocol
• protocol: string
Inherited from RequestWithSession.protocol
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:547
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:630
rawHeaders
• rawHeaders: string[]
Inherited from RequestWithSession.rawHeaders
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:869
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
rawTrailers
• rawTrailers: string[]
Inherited from RequestWithSession.rawTrailers
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:880
The raw request/response trailer keys and values exactly as they were
received. Only populated at the 'end'
event.
since
v0.11.6
readable
• readable: boolean
Inherited from RequestWithSession.readable
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:71
Is true
if it is safe to call readable.read()
, which means
the stream has not been destroyed or emitted 'error'
or 'end'
.
since
v11.4.0
Readonly
readableAborted
• readableAborted: boolean
Inherited from RequestWithSession.readableAborted
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:65
Returns whether the stream was destroyed or errored before emitting 'end'
.
since
v16.8.0
experimental
Readonly
readableDidRead
• readableDidRead: boolean
Inherited from RequestWithSession.readableDidRead
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:77
Returns whether 'data'
has been emitted.
since
v16.7.0
experimental
Readonly
readableEncoding
• readableEncoding: BufferEncoding | null
Inherited from RequestWithSession.readableEncoding
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:82
Getter for the property encoding
of a given Readable
stream. The encoding
property can be set using the readable.setEncoding()
method.
since
v12.7.0
Readonly
readableEnded
• readableEnded: boolean
Inherited from RequestWithSession.readableEnded
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:87
Becomes true
when 'end'
event is emitted.
since
v12.9.0
Readonly
readableFlowing
• readableFlowing: boolean | null
Inherited from RequestWithSession.readableFlowing
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:93
This property reflects the current state of a Readable
stream as described
in the Three states
section.
since
v9.4.0
Readonly
readableHighWaterMark
• readableHighWaterMark: number
Inherited from RequestWithSession.readableHighWaterMark
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:98
Returns the value of highWaterMark
passed when creating this Readable
.
since
v9.3.0
Readonly
readableLength
• readableLength: number
Inherited from RequestWithSession.readableLength
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:105
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
Readonly
readableObjectMode
• readableObjectMode: boolean
Inherited from RequestWithSession.readableObjectMode
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:110
Getter for the property objectMode
of a given Readable
stream.
since
v12.3.0
Optional
res
• res? : Response‹ResBody, Locals› | undefined
Inherited from RequestWithSession.res
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:648
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:632
secure
• secure: boolean
Inherited from RequestWithSession.secure
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:554
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:634
socket
• socket: Socket
Inherited from RequestWithSession.socket
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:819
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
.
since
v0.3.0
stale
• stale: boolean
Inherited from RequestWithSession.stale
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:613
Check if the request is stale, aka "Last-Modified" and / or the "ETag" for the resource has changed.
Optional
statusCode
• statusCode? : number | undefined
Inherited from RequestWithSession.statusCode
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:939
Only valid for response obtained from {@link ClientRequest}.
The 3-digit HTTP response status code. E.G. 404
.
since
v0.1.1
Optional
statusMessage
• statusMessage? : string | undefined
Inherited from RequestWithSession.statusMessage
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:946
Only valid for response obtained from {@link ClientRequest}.
The HTTP response status message (reason phrase). E.G. OK
or Internal Server Error
.
since
v0.11.10
subdomains
• subdomains: string[]
Inherited from RequestWithSession.subdomains
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:584
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:874
The request/response trailers object. Only populated at the 'end'
event.
since
v0.3.0
url
• url: string
Inherited from RequestWithSession.url
Overrides void
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:638
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:618
Check if the request was an XMLHttpRequest.
Methods
[Symbol.asyncIterator]
▸ [Symbol.asyncIterator](): AsyncIterableIterator‹any›
Inherited from RequestWithSession.[Symbol.asyncIterator]
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:479
Returns: AsyncIterableIterator‹any›
Optional
_construct
▸ _construct(callback
: function): void
Inherited from RequestWithSession._construct
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:117
Parameters:
▪ callback: function
▸ (error?
: Error | null): void
Parameters:
Name | Type |
---|---|
error? | Error | null |
Returns: void
_destroy
▸ _destroy(error
: Error | null, callback
: function): void
Inherited from RequestWithSession._destroy
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:399
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:118
Parameters:
Name | Type |
---|---|
size | number |
Returns: void
accepts
▸ accepts(): string[]
Inherited from RequestWithSession.accepts
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:439
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:440
Parameters:
Name | Type |
---|---|
type | string |
Returns: string | false
▸ accepts(type
: string[]): string | false
Inherited from RequestWithSession.accepts
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:441
Parameters:
Name | Type |
---|---|
type | string[] |
Returns: string | false
▸ accepts(...type
: string[]): string | false
Inherited from RequestWithSession.accepts
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:442
Parameters:
Name | Type |
---|---|
...type | string[] |
Returns: string | false
acceptsCharsets
▸ acceptsCharsets(): string[]
Inherited from RequestWithSession.acceptsCharsets
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:451
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:452
Parameters:
Name | Type |
---|---|
charset | string |
Returns: string | false
▸ acceptsCharsets(charset
: string[]): string | false
Inherited from RequestWithSession.acceptsCharsets
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:453
Parameters:
Name | Type |
---|---|
charset | string[] |
Returns: string | false
▸ acceptsCharsets(...charset
: string[]): string | false
Inherited from RequestWithSession.acceptsCharsets
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:454
Parameters:
Name | Type |
---|---|
...charset | string[] |
Returns: string | false
acceptsEncodings
▸ acceptsEncodings(): string[]
Inherited from RequestWithSession.acceptsEncodings
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:463
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:464
Parameters:
Name | Type |
---|---|
encoding | string |
Returns: string | false
▸ acceptsEncodings(encoding
: string[]): string | false
Inherited from RequestWithSession.acceptsEncodings
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:465
Parameters:
Name | Type |
---|---|
encoding | string[] |
Returns: string | false
▸ acceptsEncodings(...encoding
: string[]): string | false
Inherited from RequestWithSession.acceptsEncodings
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:466
Parameters:
Name | Type |
---|---|
...encoding | string[] |
Returns: string | false
acceptsLanguages
▸ acceptsLanguages(): string[]
Inherited from RequestWithSession.acceptsLanguages
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:475
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:476
Parameters:
Name | Type |
---|---|
lang | string |
Returns: string | false
▸ acceptsLanguages(lang
: string[]): string | false
Inherited from RequestWithSession.acceptsLanguages
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:477
Parameters:
Name | Type |
---|---|
lang | string[] |
Returns: string | false
▸ acceptsLanguages(...lang
: string[]): string | false
Inherited from RequestWithSession.acceptsLanguages
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:478
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:423
Event emitter The defined events on documents including:
- close
- data
- end
- error
- pause
- readable
- 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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:424
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:425
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ addListener(event
: "error", listener
: function): this
Inherited from RequestWithSession.addListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:426
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:427
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ addListener(event
: "readable", listener
: function): this
Inherited from RequestWithSession.addListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:428
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ addListener(event
: "resume", listener
: function): this
Inherited from RequestWithSession.addListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:429
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:430
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:952
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.
since
v0.3.0
Parameters:
Name | Type |
---|---|
error? | Error |
Returns: void
emit
▸ emit(event
: "close"): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:431
Parameters:
Name | Type |
---|---|
event | "close" |
Returns: boolean
▸ emit(event
: "data", chunk
: any): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:432
Parameters:
Name | Type |
---|---|
event | "data" |
chunk | any |
Returns: boolean
▸ emit(event
: "end"): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:433
Parameters:
Name | Type |
---|---|
event | "end" |
Returns: boolean
▸ emit(event
: "error", err
: Error): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:434
Parameters:
Name | Type |
---|---|
event | "error" |
err | Error |
Returns: boolean
▸ emit(event
: "pause"): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:435
Parameters:
Name | Type |
---|---|
event | "pause" |
Returns: boolean
▸ emit(event
: "readable"): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:436
Parameters:
Name | Type |
---|---|
event | "readable" |
Returns: boolean
▸ emit(event
: "resume"): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:437
Parameters:
Name | Type |
---|---|
event | "resume" |
Returns: boolean
▸ emit(event
: string | symbol, ...args
: any[]): boolean
Inherited from RequestWithSession.emit
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:438
Parameters:
Name | Type |
---|---|
event | string | symbol |
...args | any[] |
Returns: boolean
eventNames
▸ eventNames(): Array‹string | symbol›
Inherited from RequestWithSession.eventNames
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:614
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbol
s.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
since
v6.0.0
Returns: Array‹string | symbol›
get
▸ get(name
: "set-cookie"): string[] | undefined
Inherited from RequestWithSession.get
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:396
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:397
Parameters:
Name | Type |
---|---|
name | string |
Returns: string | undefined
getMaxListeners
▸ getMaxListeners(): number
Inherited from RequestWithSession.getMaxListeners
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:471
Returns the current max listener value for the EventEmitter
which is either
set by emitter.setMaxListeners(n)
or defaults to {@link defaultMaxListeners}.
since
v1.0.0
Returns: number
header
▸ header(name
: "set-cookie"): string[] | undefined
Inherited from RequestWithSession.header
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:399
Parameters:
Name | Type |
---|---|
name | "set-cookie" |
Returns: string[] | undefined
▸ header(name
: string): string | undefined
Inherited from RequestWithSession.header
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:400
Parameters:
Name | Type |
---|---|
name | string |
Returns: string | undefined
is
▸ is(type
: string | string[]): string | false | null
Inherited from RequestWithSession.is
Defined in node_modules/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:537
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:278
The readable.isPaused()
method returns the current operating state of theReadable
. This is used primarily by the mechanism that underlies thereadable.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
since
v0.11.14
Returns: boolean
listenerCount
▸ listenerCount(eventName
: string | symbol): number
Inherited from RequestWithSession.listenerCount
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:561
Returns the number of listeners listening to the event named eventName
.
since
v3.2.0
Parameters:
Name | Type | Description |
---|---|---|
eventName | string | symbol | The name of the event being listened for |
Returns: number
listeners
▸ listeners(eventName
: string | symbol): Function[]
Inherited from RequestWithSession.listeners
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:484
Returns a copy of the array of listeners for the event named eventName
.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
since
v0.1.26
Parameters:
Name | Type |
---|---|
eventName | string | symbol |
Returns: Function[]
off
▸ off(eventName
: string | symbol, listener
: function): this
Inherited from RequestWithSession.off
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:444
Alias for emitter.removeListener()
.
since
v10.0.0
Parameters:
▪ eventName: 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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:439
Parameters:
▪ event: "close"
▪ listener: function
▸ (): void
Returns: this
▸ on(event
: "data", listener
: function): this
Inherited from RequestWithSession.on
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:440
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:441
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ on(event
: "error", listener
: function): this
Inherited from RequestWithSession.on
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:442
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:443
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ on(event
: "readable", listener
: function): this
Inherited from RequestWithSession.on
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:444
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ on(event
: "resume", listener
: function): this
Inherited from RequestWithSession.on
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:445
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:446
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:447
Parameters:
▪ event: "close"
▪ listener: function
▸ (): void
Returns: this
▸ once(event
: "data", listener
: function): this
Inherited from RequestWithSession.once
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:448
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:449
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ once(event
: "error", listener
: function): this
Inherited from RequestWithSession.once
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:450
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:451
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ once(event
: "readable", listener
: function): this
Inherited from RequestWithSession.once
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:452
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ once(event
: "resume", listener
: function): this
Inherited from RequestWithSession.once
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:453
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:454
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:514
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:242
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.
since
v0.9.4
Returns: this
pipe
▸ pipe‹T›(destination
: T, options?
: object): T
Inherited from RequestWithSession.pipe
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:24
Type parameters:
▪ T: WritableStream
Parameters:
▪ destination: T
▪Optional
options: object
Name | Type |
---|---|
end? | boolean | undefined |
Returns: T
prependListener
▸ prependListener(event
: "close", listener
: function): this
Inherited from RequestWithSession.prependListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:455
Parameters:
▪ event: "close"
▪ listener: function
▸ (): void
Returns: this
▸ prependListener(event
: "data", listener
: function): this
Inherited from RequestWithSession.prependListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:456
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:457
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ prependListener(event
: "error", listener
: function): this
Inherited from RequestWithSession.prependListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:458
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:459
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ prependListener(event
: "readable", listener
: function): this
Inherited from RequestWithSession.prependListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:460
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ prependListener(event
: "resume", listener
: function): this
Inherited from RequestWithSession.prependListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:461
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:462
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:463
Parameters:
▪ event: "close"
▪ listener: function
▸ (): void
Returns: this
▸ prependOnceListener(event
: "data", listener
: function): this
Inherited from RequestWithSession.prependOnceListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:464
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:465
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ prependOnceListener(event
: "error", listener
: function): this
Inherited from RequestWithSession.prependOnceListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:466
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:467
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ prependOnceListener(event
: "readable", listener
: function): this
Inherited from RequestWithSession.prependOnceListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:468
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ prependOnceListener(event
: "resume", listener
: function): this
Inherited from RequestWithSession.prependOnceListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:469
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:470
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:398
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/.pnpm/@types+express-serve-static-core@4.17.24/node_modules/@types/express-serve-static-core/index.d.ts:493
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(eventName
: string | symbol): Function[]
Inherited from RequestWithSession.rawListeners
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:514
Returns a copy of the array of listeners for the event named eventName
,
including any wrappers (such as those created by .once()
).
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
since
v9.4.0
Parameters:
Name | Type |
---|---|
eventName | string | symbol |
Returns: Function[]
read
▸ read(size?
: number): any
Inherited from RequestWithSession.read
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:195
The readable.read()
method pulls some data out of the internal buffer and
returns it. If no data available to be read, null
is returned. By default,
the data will be 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. Ifsize
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 thesize
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.
since
v0.9.4
Parameters:
Name | Type | Description |
---|---|---|
size? | number | Optional argument to specify how much data to read. |
Returns: any
removeAllListeners
▸ removeAllListeners(event?
: string | symbol): this
Inherited from RequestWithSession.removeAllListeners
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:455
Removes all listeners, or those of the specified eventName
.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter
instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter
, so that calls can be chained.
since
v0.1.26
Parameters:
Name | Type |
---|---|
event? | string | symbol |
Returns: this
removeListener
▸ removeListener(event
: "close", listener
: function): this
Inherited from RequestWithSession.removeListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:471
Parameters:
▪ event: "close"
▪ listener: function
▸ (): void
Returns: this
▸ removeListener(event
: "data", listener
: function): this
Inherited from RequestWithSession.removeListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:472
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:473
Parameters:
▪ event: "end"
▪ listener: function
▸ (): void
Returns: this
▸ removeListener(event
: "error", listener
: function): this
Inherited from RequestWithSession.removeListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:474
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:475
Parameters:
▪ event: "pause"
▪ listener: function
▸ (): void
Returns: this
▸ removeListener(event
: "readable", listener
: function): this
Inherited from RequestWithSession.removeListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:476
Parameters:
▪ event: "readable"
▪ listener: function
▸ (): void
Returns: this
▸ removeListener(event
: "resume", listener
: function): this
Inherited from RequestWithSession.removeListener
Overrides void
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:477
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:478
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/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:261
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.
since
v0.9.4
Returns: this
setEncoding
▸ setEncoding(encoding
: BufferEncoding): this
Inherited from RequestWithSession.setEncoding
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:220
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 asBuffer
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. Callingreadable.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);
});
since
v0.9.4
Parameters:
Name | Type | Description |
---|---|---|
encoding | BufferEncoding | The encoding to use. |
Returns: this
setMaxListeners
▸ setMaxListeners(n
: number): this
Inherited from RequestWithSession.setMaxListeners
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/events.d.ts:465
By default EventEmitter
s will print a warning if more than 10
listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners()
method allows the limit to be
modified for this specific EventEmitter
instance. The value can be set toInfinity
(or 0
) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter
, so that calls can be chained.
since
v0.3.5
Parameters:
Name | Type |
---|---|
n | number |
Returns: this
setTimeout
▸ setTimeout(msecs
: number, callback?
: function): this
Inherited from RequestWithSession.setTimeout
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/http.d.ts:885
Calls message.socket.setTimeout(msecs, callback)
.
since
v0.5.9
Parameters:
▪ msecs: number
▪Optional
callback: function
▸ (): void
Returns: this
unpipe
▸ unpipe(destination?
: WritableStream): this
Inherited from RequestWithSession.unpipe
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:305
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.
const fs = require('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);
since
v0.9.4
Parameters:
Name | Type | Description |
---|---|---|
destination? | WritableStream | Optional specific stream to unpipe |
Returns: this
unshift
▸ unshift(chunk
: any, encoding?
: BufferEncoding): void
Inherited from RequestWithSession.unshift
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:371
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).
const { StringDecoder } = require('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.match(/\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);
} else {
// 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.
since
v0.9.11
Parameters:
Name | Type | Description |
---|---|---|
chunk | any | Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer , Uint8Array 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
wrap
▸ wrap(stream
: ReadableStream): this
Inherited from RequestWithSession.wrap
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:397
Prior to Node.js 0.10, streams did not implement the entire 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, thereadable.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.
const { OldReader } = require('./old-api-module.js');
const { Readable } = require('stream');
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);
myReader.on('readable', () => {
myReader.read(); // etc.
});
since
v0.9.4
Parameters:
Name | Type | Description |
---|---|---|
stream | ReadableStream | An "old style" readable stream |
Returns: this
Static
from
▸ from(iterable
: Iterable‹any› | AsyncIterable‹any›, options?
: ReadableOptions): Readable
Inherited from RequestWithSession.from
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:54
A utility method for creating Readable Streams out of iterators.
Parameters:
Name | Type |
---|---|
iterable | Iterable‹any› | AsyncIterable‹any› |
options? | ReadableOptions |
Returns: Readable
Static
isDisturbed
▸ isDisturbed(stream
: Readable | ReadableStream): boolean
Inherited from RequestWithSession.isDisturbed
Defined in node_modules/.pnpm/@types+node@16.11.7/node_modules/@types/node/stream.d.ts:59
Returns whether the stream has been read from or cancelled.
since
v16.8.0
Parameters:
Name | Type |
---|---|
stream | Readable | ReadableStream |
Returns: boolean