kronos-service-koa

koa backed http server

API

Table of Contents

• ServiceHTTP
  • Properties
  • extendetName
  • endpointFactoryFromConfig
    • Parameters
  • name
• HTTPEndpoint
  • Parameters
• WSEndpoint
  • Parameters
  • Properties
• authenticate
  • Parameters
• CTXInterceptor
  • name
• CTXBodyParamInterceptor
  • name
• CTXJWTVerifyInterceptor
  • name
• reportError
  • Parameters

ServiceHTTP

Extends Service

HTTP server

Properties

• server http.Server only present if state is running

extendetName

Returns string name with url

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 'http'

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 {})
  • options.path string url path defaults to endpoint name

Properties

• sockets Set<WebSocket>

authenticate

check sec-websocket-protocol header for presence of 'access_token' and the token

Parameters

• service Service
• request any

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'

reportError

Write WWW-Authenticate header

Parameters

• ctx any
• error any
• description any

install

With npm do:

npm install kronos-service-koa

license

BSD-2-Clause