PlatformRouter

@tsed/platform-router

Usage

import { PlatformRouter } from "@tsed/platform-router";

See /packages/platform/platform-router/src/types/domain/PlatformRouter.ts.

Overview

class PlatformRouter {
    readonly layers: PlatformLayer[];
    provider: Provider;
    use(...handlers: any[]): this;
    addRoute(method: string, path: SinglePathType, handlers: any[], opts?: PlatformLayerOptions): this;
    all(path: SinglePathType, ...handlers: any[]): this;
    get(path: SinglePathType, ...handlers: any[]): this;
    post(path: SinglePathType, ...handlers: any[]): this;
    put(path: SinglePathType, ...handlers: any[]): this;
    delete(path: SinglePathType, ...handlers: any[]): this;
    patch(path: SinglePathType, ...handlers: any[]): this;
    head(path: SinglePathType, ...handlers: any[]): this;
    options(path: SinglePathType, ...handlers: any[]): this;
    statics(path: string, options: any): this;
    inspect(): {
        handlers: any[];
        path: any;
        basePath: string;
        method: string;
        opts: {};
    }[];
    isBuilt(): boolean;
}

readonly layers

readonly layers: PlatformLayer[];

provider

provider: Provider;

use

use(...handlers: any[]): this;

addRoute

addRoute(method: string, path: SinglePathType, handlers: any[], opts?: PlatformLayerOptions): this;

all

all(path: SinglePathType, ...handlers: any[]): this;

get

get(path: SinglePathType, ...handlers: any[]): this;

post

post(path: SinglePathType, ...handlers: any[]): this;

put

put(path: SinglePathType, ...handlers: any[]): this;

delete

delete(path: SinglePathType, ...handlers: any[]): this;

patch

patch(path: SinglePathType, ...handlers: any[]): this;

head

head(path: SinglePathType, ...handlers: any[]): this;

options

options(path: SinglePathType, ...handlers: any[]): this;

statics

statics(path: string, options: any): this;

inspect

inspect(): {
     handlers: any[];
     path: any;
     basePath: string;
     method: string;
     opts: {};
 }[];

isBuilt

isBuilt(): boolean;