kronos-service-koa

koa backed http server

API

Table of Contents

• ServiceKOA
  • Parameters
  • Properties
  • endpointFactoryFromConfig
    • Parameters
  • name
• HTTPEndpoint
  • Parameters
• WSEndpoint
  • Parameters
• CTXInterceptor
  • name
• CTXBodyParamInterceptor
  • name
• CTXJWTVerifyInterceptor
  • name

ServiceKOA

Extends Service

HTTP server with koa

Parameters

• args ...any

Properties

• server http.Server only present if state is running
• koa koa

endpointFactoryFromConfig

on demand create RouteSendEndpoint´s

Parameters

• name string
• definition (Object | string)
• ic

Returns Class RouteSendEndpoint if path is present of name starts with '/'

name

Returns string 'koa'

HTTPEndpoint

Extends SendEndpoint

Endpoint to link against a http route

Parameters

• name string endpoint name
• owner Object owner of the endpoint
• options Object (optional, default {})

WSEndpoint

Extends SendEndpoint

Endpoint to link against a websocket route

Parameters

• name string endpoint name
• owner Object owner of the endpoint
• options Object (optional, default {})

CTXInterceptor

Extends Interceptor

extracts params form request body

name

Returns string 'ctx-body-param'

CTXBodyParamInterceptor

Extends Interceptor

extracts params form request body

name

Returns string 'ctx-body-param'

CTXJWTVerifyInterceptor

Extends Interceptor

only forward requests if a valid jwt token is present

name

Returns string 'ctx-jwt-verify'

install

With npm do:

npm install kronos-service-koa

license

BSD-2-Clause