Class Router

constructor

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

• Parameters

  • logger: Logger
  • server: MoxyServer
  • Optionaloptions: RouterConfig

  Returns Router

onceRouterPaths

options

routerPaths

routes

addRoute

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

• Adds a route

  Parameters

  • path: string

    The path
  • config: RouteConfig

    The configuration
  • Optionaloptions: AddRouteOptions

    Options for the route

  Returns this

addRoutes

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

• Adds many routes

  Parameters

  • prefix: string

    The path prefix to prepend to all routes
  • routes: Routes

    Path suffix keyed RouteConfig
  • Optionaloptions: AddRouteOptions

    Options for the routes

  Returns this

createProxy

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

• Creates a simple opaque proxy

  Parameters

  • request: IncomingMessage

    The request
  • response: MoxyResponse

    The response
  • proxyUrl: string

    The proxy url
  • Optionaloptions: RequestOptions

    The request options

  Returns void

handleApi

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

• Handle requests to api routes (/_moxy)

  Parameters

  • req: MoxyRequest

    The request
  • res: MoxyResponse

    The response

  Returns Promise<MoxyResponse>

parsePlaceholderParams

• parsePlaceholderParams(url: string): string

• Convert simple replacement params into regex match groups

  Parameters

  • url: string

    The url

  Returns string

removeRoute

• removeRoute(path: string): this

• Removes a route

  Parameters

  • path: string

    The path

  Returns this

requestListener

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

• 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>

• 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>