@kronos-integration/service-http

http server

API

$3

* CTXBodyParamInterceptor
* name
* CTXInterceptor
* name
* CTXJWTVerifyInterceptor
* name
* reportError
* Parameters
* CTX
* Properties
* HTTPEndpoint
* Parameters
* endpointRouter
* Parameters
* ServiceHTTP
* Properties
* extendetName
* endpointFactoryFromConfig
* Parameters
* isSecure
* name
* WSEndpoint
* Parameters
* Properties
* authenticate
* Parameters

CTXBodyParamInterceptor

Extends CTXInterceptor

Extracts params from request body.
Supported content types are:

* application/json
* application/x-www-form-urlencoded

$3

Returns string 'ctx-body-param'

CTXInterceptor

Extends Interceptor

Basic interceptor providing/consuming http request/response.

$3

Returns string 'ctx'

CTXJWTVerifyInterceptor

Extends Interceptor

Only forward requests if a valid JWT token is present.

$3

Returns string 'ctx-jwt-verify'

reportError

Write WWW-Authenticate header.

$3

* ctx any
* code
* error Error?
* description string?

CTX

Type: Object

$3

* res ServerResponse
* req ServerRequest
* is Function
* throw Function

HTTPEndpoint

Extends SendEndpoint

Endpoint to link against a http route.

The endpoint name may be in the form of ':'.
Then will be used as http method
and as the url path component.

$3

* name string endpoint name
* owner Object owner of the endpoint
* options Object

* options.path string url path component defaults to endpoint name
* options.method string http method defaults to GET

endpointRouter

$3

* httpService HTTPServer

Returns RequestListener

ServiceHTTP

Extends Service

HTTP server.

$3

* server http.Server only present if state is running

$3

Returns string name with url

$3

On demand create RouteSendEndpoint´s.

#### Parameters

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

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

$3

Should we make a secure connection.

Returns boolean true if key is present

$3

Returns string 'http'

WSEndpoint

Extends SendReceiveEndpoint

Endpoint to link against a websocket route.

$3

* name string endpoint name
* owner Object owner of the endpoint
* options Object

* options.path string url path defaults to endpoint name

$3

* sockets Set<WebSocket>

authenticate

Check sec-websocket-protocol header for presence of
'access\_token' and the token.
Throws if no valid token is present.

$3

* service Service
* request any

install

With npm do:

``shell
npm install @kronos-integration/service-http
``

license

BSD-2-Clause