Interface Request<P>

Incoming request, including some information about the client.

interface Request<P> {
    body?: any;
    method: string;
    params?: P;
    path: string;
    query?: { [key: string]: undefined | string };
}

Type Parameters

P

Hierarchy

IncomingMessage
- Request

Index

Properties

body? method params? path query?

Properties

`Optional`body

body?: any

method

method: string

Only valid for request obtained from Server.

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

Since

v0.1.1

`Optional`params

params?: P

path

path: string

`Optional`query

query?: { [key: string]: undefined | string }