<commit_before>[![npm](https://img.shields.io/npm/v/@kronos-integration/endpoint.svg)](https://www.npmjs.com/package/@kronos-integration/endpoint)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![minified size](https://badgen.net/bundlephobia/min/@kronos-integration/endpoint)](https://bundlephobia.com/result?p=@kronos-integration/endpoint)
[![downloads](http://img.shields.io/npm/dm/@kronos-integration/endpoint.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/endpoint)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

# kronos-endpoint

Named communication (end)-points inside of kronos

![request forwarding](doc/images/requestForwarding.svg "Requests Forwading"){:height="310pt" width="325pt"}

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [Endpoint](#endpoint)
    -   [Parameters](#parameters)
    -   [isDefault](#isdefault)
    -   [isDummy](#isdummy)
    -   [toStringAttributes](#tostringattributes)
    -   [isIn](#isin)
    -   [isOut](#isout)
    -   [direction](#direction)
    -   [jsonAttributes](#jsonattributes)
    -   [hasInterceptors](#hasinterceptors)
    -   [connectable](#connectable)
        -   [Parameters](#parameters-1)
    -   [hasConnections](#hasconnections)
    -   [isConnected](#isconnected)
        -   [Parameters](#parameters-2)
    -   [openConnection](#openconnection)
        -   [Parameters](#parameters-3)
    -   [closeConnection](#closeconnection)
        -   [Parameters](#parameters-4)
    -   [openConnections](#openconnections)
    -   [closeConnections](#closeconnections)
-   [isEndpoint](#isendpoint)
    -   [Parameters](#parameters-5)
-   [instanciateInterceptors](#instanciateinterceptors)
    -   [Parameters](#parameters-6)
-   [ReceivableEndpoint](#receivableendpoint)
    -   [Parameters](#parameters-7)
    -   [isIn](#isin-1)
    -   [receive](#receive)
    -   [receive](#receive-1)
        -   [Parameters](#parameters-8)
-   [MultiConnectionEndpoint](#multiconnectionendpoint)
    -   [Parameters](#parameters-9)
    -   [getConnectionState](#getconnectionstate)
        -   [Parameters](#parameters-10)
    -   [setConnectionState](#setconnectionstate)
        -   [Parameters](#parameters-11)
    -   [isConnected](#isconnected-1)
        -   [Parameters](#parameters-12)
    -   [connections](#connections)
-   [SendEndpoint](#sendendpoint)
    -   [Parameters](#parameters-13)
    -   [isOut](#isout-1)
-   [ReceiveEndpoint](#receiveendpoint)
    -   [Parameters](#parameters-14)
    -   [isIn](#isin-2)
-   [DummyReceiveEndpoint](#dummyreceiveendpoint)
    -   [receive](#receive-2)
    -   [isIn](#isin-3)
    -   [isDummy](#isdummy-1)
-   [SendEndpointDefault](#sendendpointdefault)
    -   [isDefault](#isdefault-1)
-   [MultiSendEndpoint](#multisendendpoint)
    -   [Parameters](#parameters-15)
    -   [isOut](#isout-2)
-   [ReceiveEndpointDefault](#receiveendpointdefault)
    -   [isDefault](#isdefault-2)
-   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)

## Endpoint

### Parameters

-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** endpoint name
-   `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
    -   `options.didConnect` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** called after receiver is present
    -   `options.interceptors` **(Interceptor | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>)?** interceptors

### isDefault
<commit_msg>docs(README): sync API<commit_after>[![npm](https://img.shields.io/npm/v/@kronos-integration/endpoint.svg)](https://www.npmjs.com/package/@kronos-integration/endpoint)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![minified size](https://badgen.net/bundlephobia/min/@kronos-integration/endpoint)](https://bundlephobia.com/result?p=@kronos-integration/endpoint)
[![downloads](http://img.shields.io/npm/dm/@kronos-integration/endpoint.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/endpoint)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

# kronos-endpoint

Named communication (end)-points inside of kronos

![request forwarding](doc/images/requestForwarding.svg "Requests Forwading"){:height="310pt" width="325pt"}

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [Endpoint](#endpoint)
    -   [Parameters](#parameters)
    -   [displayName](#displayname)
    -   [isDefault](#isdefault)
    -   [isDummy](#isdummy)
    -   [toStringAttributes](#tostringattributes)
    -   [isIn](#isin)
    -   [isOut](#isout)
    -   [direction](#direction)
    -   [jsonAttributes](#jsonattributes)
    -   [hasInterceptors](#hasinterceptors)
    -   [connectable](#connectable)
        -   [Parameters](#parameters-1)
    -   [hasConnections](#hasconnections)
    -   [isConnected](#isconnected)
        -   [Parameters](#parameters-2)
    -   [openConnection](#openconnection)
        -   [Parameters](#parameters-3)
    -   [closeConnection](#closeconnection)
        -   [Parameters](#parameters-4)
    -   [openConnections](#openconnections)
    -   [closeConnections](#closeconnections)
-   [isEndpoint](#isendpoint)
    -   [Parameters](#parameters-5)
-   [instanciateInterceptors](#instanciateinterceptors)
    -   [Parameters](#parameters-6)
-   [ReceivableEndpoint](#receivableendpoint)
    -   [Parameters](#parameters-7)
    -   [isIn](#isin-1)
    -   [receive](#receive)
    -   [receive](#receive-1)
        -   [Parameters](#parameters-8)
-   [MultiConnectionEndpoint](#multiconnectionendpoint)
    -   [Parameters](#parameters-9)
    -   [getConnectionState](#getconnectionstate)
        -   [Parameters](#parameters-10)
    -   [setConnectionState](#setconnectionstate)
        -   [Parameters](#parameters-11)
    -   [isConnected](#isconnected-1)
        -   [Parameters](#parameters-12)
    -   [connections](#connections)
-   [SendEndpoint](#sendendpoint)
    -   [Parameters](#parameters-13)
    -   [isOut](#isout-1)
-   [ReceiveEndpoint](#receiveendpoint)
    -   [Parameters](#parameters-14)
    -   [isIn](#isin-2)
-   [DummyReceiveEndpoint](#dummyreceiveendpoint)
    -   [receive](#receive-2)
    -   [isIn](#isin-3)
    -   [isDummy](#isdummy-1)
-   [SendEndpointDefault](#sendendpointdefault)
    -   [isDefault](#isdefault-1)
-   [MultiSendEndpoint](#multisendendpoint)
    -   [Parameters](#parameters-15)
    -   [isOut](#isout-2)
-   [ReceiveEndpointDefault](#receiveendpointdefault)
    -   [isDefault](#isdefault-2)
-   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)

## Endpoint

### Parameters

-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** endpoint name
-   `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
-   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
    -   `options.didConnect` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** called after receiver is present
    -   `options.interceptors` **(Interceptor | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>)?** interceptors

### displayName

Name as presented for humans.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

### isDefault

{'fraction_non_alphanumeric': 0.17580888321929722, 'fraction_numerical': 0.010437202829641655, 'mean_word_length': 4.1517323775388295, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 33, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2287712', 'n_tokens_mistral': 2961, 'n_tokens_neox': 2628, 'n_words': 257}