Module "index"

Index

Classes

Server

Interfaces

Variables

any

Functions

Variables

Const any

any: Filter<[]> = filter([])

A filter that matches any request

Functions

serve

serve(filter: Filter<[Reply]>): Server
serve(filter: Filter<[Reply]>, options: HttpOptions | HttpsOptions): Server
serve(filter: Filter<[Reply]>, w: With<[Reply]>): Server
serve(filter: Filter<[Reply]>, options: HttpOptions | HttpsOptions, w: With<[Reply]>): Server

- Defined in src/index.ts:195
Creates a server serving the provided filter

Parameters
- filter: Filter<[Reply]>
  
  Filter to serve
Returns Server
- Defined in src/index.ts:202
Creates a server with the provided options serving the provided filter

Parameters
- filter: Filter<[Reply]>
  
  Filter to serve
- options: HttpOptions | HttpsOptions
  
  Options for the inner http.Server (will automatically use HTTPS if both cert and key are provided)
Returns Server
- Defined in src/index.ts:213
Creates a server serving the provided filter using the provided With wrapper globally

Parameters
- filter: Filter<[Reply]>
  
  Filter to serve
- w: With<[Reply]>
  
  Global With wrapper
Returns Server
- Defined in src/index.ts:222
Creates a server with the provided options serving the provided filter using the provided With wrapper globally

Parameters
- filter: Filter<[Reply]>
  
  Filter to serve
- options: HttpOptions | HttpsOptions
  
  Options for the inner http.Server (will automatically use HTTPS if both cert and key are provided)
- w: With<[Reply]>
  
  Global With wrapper
Returns Server

writeReply

writeReply(reply: Reply, response: ServerResponse, body?: boolean): void

- Defined in src/index.ts:50
Writes a Reply to Node's http.ServerResponse

Parameters
- reply: Reply
  
  The reply to write
- response: ServerResponse
  
  The response to write to
- Default value body: boolean = true
  
  Whether to write the provided body
Returns void

Generated using TypeDoc