External module "host/helpers"

Index

Interfaces

CompressForResponseResult

Type aliases

LoadCSSAndJavascriptCallback

Functions

Type aliases

LoadCSSAndJavascriptCallback

LoadCSSAndJavascriptCallback: function

Describes a callback for the 'loadCSSAndJavascript()' function.

param: The loaded CSS data (if found).
param: The loaded JavaScript data (if found).

Type declaration

- (css: string, js: string): void
- Parameters
  - css: string
  - js: string
  Returns void

Functions

compressForResponse

compressForResponse(data: any, ctx: RequestContext, encoding?: string): PromiseLike<CompressForResponseResult>

- Defined in host/helpers.ts:76
Tries to compress data for a reponse.

Parameters
- data: any
  
  The data to compress.
- ctx: RequestContext
  
  The underlying request context.
- Optional encoding: string
  
  The custom text encoding to use, if 'data' is no buffer.
Returns PromiseLike<CompressForResponseResult>

The result.

sendError

sendError(err: any, ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:162
Sends an error response.

Parameters
- err: any
  
  The error to send.
- ctx: RequestContext
  
  The request context.
- Default value code: number = 500
  
  The custom status code to send.
Returns void

sendForbidden

sendForbidden(ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:180
Sends a "forbidden" response.

Parameters
- ctx: RequestContext
  
  The request context.
- Default value code: number = 403
  
  The custom status code to send.
Returns void

sendMethodNotAllowed

sendMethodNotAllowed(ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:197
Sends a "method not allowed" response.

Parameters
- ctx: RequestContext
  
  The request context.
- Default value code: number = 405
  
  The custom status code to send.
Returns void

sendNotFound

sendNotFound(ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:214
Sends a "not found" response.

Parameters
- ctx: RequestContext
  
  The request context.
- Default value code: number = 404
  
  The custom status code to send.
Returns void

sendNotImplemented

sendNotImplemented(ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:231
Sends a "not implemented" response.

Parameters
- ctx: RequestContext
  
  The request context.
- Default value code: number = 501
  
  The custom status code to send.
Returns void

sendUnauthorized

sendUnauthorized(ctx: RequestContext, code?: number): void

- Defined in host/helpers.ts:248
Sends an "unauthorized" response.

Parameters
- ctx: RequestContext
  
  The request context.
- Default value code: number = 401
  
  The custom status code to send.
Returns void

urlParamsToObject

urlParamsToObject(url: Url): Object

- Defined in host/helpers.ts:275
Extracts the query parameters of an URL to an object.

Parameters
- url: Url
  
  The URL.
Returns Object

The parameters of the URL as object.

Generated using TypeDoc