WebRequest interface

Represents an Express or Restify request object. This interface supports the framework and is not intended to be called directly for your code.

Properties

body

Optional. The request body.

headers

Optional. The request headers.

method

Optional. The request method.

params

Optional. The request parameters from the url.

query

Optional. The values from the query string.

Methods

on(string, any[])

When implemented in a derived class, adds a listener for an event. The framework uses this method to retrieve the request body when the body property is null or undefined.

Property Details

body

Optional. The request body.

body?: any

Property Value

any

headers

Optional. The request headers.

headers: any

Property Value

any

method

Optional. The request method.

method?: any

Property Value

any

params

Optional. The request parameters from the url.

params?: any

Property Value

any

query

Optional. The values from the query string.

query?: any

Property Value

any

Method Details

on(string, any[])

When implemented in a derived class, adds a listener for an event. The framework uses this method to retrieve the request body when the body property is null or undefined.

function on(event: string, args: any[])

Parameters

event
string

The event name.

args
any[]

Arguments used to handle the event.

Returns

any

A reference to the request object.