Class Router

Hierarchy

Router

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Router(logger: Logger, server: MoxyServer, options?: RouterConfig): Router

- Defined in router/router.ts:62
Parameters
- logger: Logger
- server: MoxyServer
- Optional options: RouterConfig
Returns Router

Properties

onceRouterPaths

onceRouterPaths: [string, ParsedPathConfig][] = []

Entries of [router path, ParsedPathConfig] for single-use routes

options

options: RouterConfig

Router config options

routerPaths

routerPaths: [string, ParsedPathConfig][] = []

Entries of [router path, ParsedPathConfig]

routes

routes: Record<string, ParsedPathConfig> = {}

Path-keyed router route config object

Methods

addRoute

addRoute(path: string, config: RouteConfig, options?: AddRouteOptions): Router

- Defined in router/router.ts:77
Adds a route

Parameters
- path: string
  
  The path
- config: RouteConfig
  
  The configuration
- Optional options: AddRouteOptions
  
  Options for the route
Returns Router

addRoutes

addRoutes(prefix: string, routes: Routes, options?: AddRouteOptions): Router

- Defined in router/router.ts:118
Adds many routes

Parameters
- prefix: string
  
  The path prefix to prepend to all routes
- routes: Routes
  
  Path suffix keyed RouteConfig
- Optional options: AddRouteOptions
  
  Options for the routes
Returns Router

createProxy

createProxy(request: IncomingMessage, response: MoxyResponse, proxyUrl: string, options?: RequestOptions): void

- Defined in router/router.ts:192
Creates a simple opaque proxy

Parameters
- request: IncomingMessage
  
  The request
- response: MoxyResponse
  
  The response
- proxyUrl: string
  
  The proxy url
- Optional options: RequestOptions
  
  The request options
Returns void

handleApi

handleApi(req: MoxyRequest, res: MoxyResponse): Promise<MoxyResponse>

- Defined in router/router.ts:146
Handle requests to api routes (/_moxy)

Parameters
- req: MoxyRequest
  
  The request
- res: MoxyResponse
  
  The response
Returns Promise<MoxyResponse>

parsePlaceholderParams

parsePlaceholderParams(url: string): string

- Defined in router/router.ts:362
Convert simple replacement params into regex match groups

Parameters
- url: string
  
  The url
Returns string

removeRoute

removeRoute(path: string): Router

- Defined in router/router.ts:131
Removes a route

Parameters
- path: string
  
  The path
Returns Router

requestListener

requestListener(req: MoxyRequest, res: MoxyResponse): Promise<void | MoxyResponse>

- Defined in router/router.ts:247
Server request listener

Parameters
- req: MoxyRequest
  
  The request
- res: MoxyResponse
  
  The resource
Returns Promise<void | MoxyResponse>

tryHandleRequest

tryHandleRequest(req: MoxyRequest, res: MoxyResponse, url: string, routeConfig: ParsedPathConfig): Promise<void | MoxyResponse>

- Defined in router/router.ts:299
Handles server request based on path config

Parameters
- req: MoxyRequest
  
  The request
- res: MoxyResponse
  
  The resource
- url: string
  
  The url to test
- routeConfig: ParsedPathConfig
  
  The parsed route config
Returns Promise<void | MoxyResponse>

Generated using TypeDoc