Class MoxyServer

Hierarchy

MoxyServer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MoxyServer(config?: ServerConfig): MoxyServer

- Defined in server/moxy-server.ts:41
Parameters
- Optional config: ServerConfig
Returns MoxyServer

Properties

router

router: Router

The internal router

Optional server

server?: Server

Instance of HTTP server

Accessors

logLevel

get logLevel(): string
set logLevel(value: string): void

- Defined in server/moxy-server.ts:59
Get current log level

Returns string
- Defined in server/moxy-server.ts:66
Set current log level

Parameters
- value: string
Returns void

port

get port(): number

- Defined in server/moxy-server.ts:52
The listening server port

Returns number

Methods

addRoutesFromFolder

addRoutesFromFolder(path: string): Promise<MoxyServer>

- Defined in server/moxy-server.ts:148
Recursively search the folder at for files matching .routes.js(on) and import their config

Parameters
- path: string
Returns Promise<MoxyServer>

close

close(options?: CloseServerOptions): Promise<void>

- Defined in server/moxy-server.ts:257
Close the HTTP server

Parameters
- Optional options: CloseServerOptions
  
  Close server options
Returns Promise<void>

getFolderContents

getFolderContents(dirPath: string): Promise<Dirent[]>

- Defined in server/moxy-server.ts:176
Gets the folder contents

Parameters
- dirPath: string
  
  The dir path
Returns Promise<Dirent[]>
{Promise<fsDirent[]>

listen

listen(port?: number): Promise<Server>

- Defined in server/moxy-server.ts:212
Start the HTTP server

Parameters
- port: number = 0
Returns Promise<Server>

loadConfigFromFile

loadConfigFromFile(filePath: string, basePath: string): void

- Defined in server/moxy-server.ts:192
Loads a configuration from file

Parameters
- filePath: string
  
  The file path
- basePath: string
  
  The base path
Returns void

off

off(path: string): MoxyServer

- Defined in server/moxy-server.ts:107
Remove path handler

Parameters
- path: string
  
  The path
Returns MoxyServer

on

on(path: string, config: RouteConfig, options?: AddRouteOptions): MoxyServer

- Defined in server/moxy-server.ts:79
Add path config handler

Parameters
- path: string
  
  The path
- config: RouteConfig
  
  The route handler config
- Optional options: AddRouteOptions
  
  Extra router options
Returns MoxyServer

onAll

onAll(prefix: string, routes: Routes, options?: AddRouteOptions): MoxyServer

- Defined in server/moxy-server.ts:94
Same as calling @MoxyServer.on over Object.entries with a prefx

Parameters
- prefix: string
  
  The path prefix to prepend to all routes
- routes: Routes
  
  Path suffix keyed RouteConfig
- Optional options: AddRouteOptions
  
  Extra router options
Returns MoxyServer

once

once(path: string, config: RouteConfig | Routes, options?: AddRouteOptions): MoxyServer

- Defined in server/moxy-server.ts:122
Add path handler which removes its self after the first response

Parameters
- path: string
  
  The path
- config: RouteConfig | Routes
  
  The configuration
- Optional options: AddRouteOptions
  
  Extra router options
Returns MoxyServer

resetRoutes

resetRoutes(): MoxyServer

- Defined in server/moxy-server.ts:133
Clear all routing config

Returns MoxyServer

Generated using TypeDoc