@kronos-integration/interceptor

intercepects / modifies requests as they pass between endpoints

``javascript
const { Interceptor } from '@kronos-integration/interceptor';

const endpoint = { get name() { return 'aName'; }, receive() {}};
const interceptor = new Interceptor();

const response = interceptor.receive(endpoint, arg1, arg2);
`

API

$3

* Endpoint
* Interceptor
* Parameters
* type
* attributes
* configure
* Parameters
* toJSONWithOptions
* Parameters
* reset
* receive
* Parameters
* attributes
* IntervalInterceptor
* Properties
* name
* LimitingInterceptor
* Parameters
* name
* LoggingInterceptor
* name
* StatsCollectorInterceptor
* receive
* Parameters
* name
* TemplateInterceptor
* name
* TimeoutInterceptor
* Properties
* name
* rejectUnlessResolvedWithin
* Parameters

Endpoint

Type: Object

Interceptor

Base interceptor. The base class for all the interceptors
Calls configure() and reset().

$3

* config Object?

$3

The instance method returning the type.
Defaults to the constructors name (class name)

Returns string

$3

Meta description of the configuration.

Returns Object

$3

Takes attribute values from config parameters
and copies them over to the object.
Copying is done according to attributes.
Which means we loop over all configuration attributes
and then for each attribute decide if we use the default, call
a setter function or simply assign the attribute value.

#### Parameters

* config Object?

$3

Deliver the json representation.

#### Parameters

* options

Returns Object json representation

$3

Forget all accumulated information.

$3

The receive method. This method receives the request from the leading interceptor
and calls the trailing interceptor.

#### Parameters

* endpoint Endpoint
* next Function
* args Array\ the request from the leading interceptor

Returns Promise\

$3

Meta description of the configuration

Returns Object

IntervalInterceptor

Extends Interceptor

Only passes requests after inteval time has passed

$3

* interval number

$3

Returns string 'interval'

LimitingInterceptor

Extends Interceptor

Limits the number of concurrent requests.
Requests can be delayed or rejected.
Sample config:
\[
{ count: 20 },
{ count: 10, delay: 100 },
{ count: 5, delay: 10 }
]
1 - 4 : no delay
5 - 9 : 10ms delay
10 - 19 : 100ms delay
20 : reject
default is to reject when more than 10 requests are on the way

$3

* config Object?

$3

Returns string 'request-limit'

LoggingInterceptor

Extends Interceptor

logs args and result

$3

Returns string 'logging'

StatsCollectorInterceptor

Extends Interceptor

Interceptor to collect processing time, number of
processed and failed requests.

$3

Logs the time the requests takes

#### Parameters

* endpoint
* next
* args ...any

$3

Returns string 'collect-request-stats'

TemplateInterceptor

Extends Interceptor

Map params into requests.

$3

Returns string 'template'

TimeoutInterceptor

Extends Interceptor

Rejects a request if it does not resolve in a given time.

$3

* timeout number

$3

Returns string 'timeout'

rejectUnlessResolvedWithin

Rejects promise when it is not resolved within given timeout.

$3

* promise Promise\
* timeout number in miliseconds
* source Interceptor

Returns Promise\

install

With npm do:

`shell
npm install @kronos-integration/interceptor
``

license

BSD-2-Clause