[![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-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html) [![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org) [![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/endpoint\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/endpoint) [![downloads](http://img.shields.io/npm/dm/@kronos-integration/endpoint.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/endpoint) [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/endpoint.svg?style=flat-square)](https://github.com/Kronos-Integration/endpoint/issues) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fendpoint%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/endpoint/goto) [![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/) [![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/endpoint/badge.svg)](https://snyk.io/test/github/Kronos-Integration/endpoint) # kronos-endpoint Named communication (end)-points inside of kronos ![request forwarding](doc/images/requestForwarding.svg "Requests Forwading"){:height="310pt" width="325pt"} # API ### Table of Contents * [DummyReceiveEndpoint](#dummyreceiveendpoint) * [receive](#receive) * [isIn](#isin) * [isOpen](#isopen) * [isDummy](#isdummy) * [ConnectionState](#connectionstate) * [Endpoint](#endpoint) * [Parameters](#parameters) * [displayName](#displayname) * [isDefault](#isdefault) * [isDummy](#isdummy-1) * [toStringAttributes](#tostringattributes) * [connectionNamesWithStates](#connectionnameswithstates) * [Parameters](#parameters-1) * [isIn](#isin-1) * [isOut](#isout) * [direction](#direction) * [jsonAttributes](#jsonattributes) * [toJSONWithOptions](#tojsonwithoptions) * [Parameters](#parameters-2) * [hasInterceptors](#hasinterceptors) * [connectable](#connectable) * [Parameters](#parameters-3) * [hasConnections](#hasconnections) * [isConnected](#isconnected) * [Parameters](#parameters-4) * [openConnection](#openconnection) * [Parameters](#parameters-5) * [closeConnection](#closeconnection) * [Parameters](#parameters-6) * [openConnections](#openconnections) * [closeConnections](#closeconnections) * [connections](#connections) * [addConnection](#addconnection) * [Parameters](#parameters-7) * [removeConnection](#removeconnection) * [Parameters](#parameters-8) * [getConnectionState](#getconnectionstate) * [Parameters](#parameters-9) * [setConnectionState](#setconnectionstate) * [Parameters](#parameters-10) * [didConnect](#didconnect) * [Parameters](#parameters-11) * [isEndpoint](#isendpoint) * [Parameters](#parameters-12) * [instanciateInterceptors](#instanciateinterceptors) * [Parameters](#parameters-13) * [MultiConnectionEndpoint](#multiconnectionendpoint) * [Parameters](#parameters-14) * [getConnectionState](#getconnectionstate-1) * [Parameters](#parameters-15) * [setConnectionState](#setconnectionstate-1) * [Parameters](#parameters-16) * [removeConnection](#removeconnection-1) * [Parameters](#parameters-17) * [isConnected](#isconnected-1) * [Parameters](#parameters-18) * [connections](#connections-1) * [connections](#connections-2) * [MultiSendEndpoint](#multisendendpoint) * [Parameters](#parameters-19) * [isOut](#isout-1) * [ReceivableEndpoint](#receivableendpoint) * [Parameters](#parameters-20) * [isIn](#isin-2) * [ReceiveEndpointDefault](#receiveendpointdefault) * [isDefault](#isdefault-1) * [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault) * [removeConnection](#removeconnection-2) * [Parameters](#parameters-21) * [ReceiveEndpoint](#receiveendpoint) * [Parameters](#parameters-22) * [isIn](#isin-3) * [SendEndpointDefault](#sendendpointdefault) * [isDefault](#isdefault-2) * [SendEndpoint](#sendendpoint) * [Parameters](#parameters-23) * [isOut](#isout-2) * [addConnection](#addconnection-1) * [Parameters](#parameters-24) * [removeConnection](#removeconnection-3) * [Parameters](#parameters-25) * [SendReceiveEndpoint](#sendreceiveendpoint) * [isIn](#isin-4) ## DummyReceiveEndpoint **Extends Endpoint** Dummy endpoints are used during construction of the endpoint mesh. The will be replaces by real endpoints during the resolving phase. ### receive dummy does nothing by intention. ### isIn Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true ### isOpen Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true ### isDummy Indicate whatever we are a dummy endpoint. Dummy endpoints are used duiring construction of the endpoint mesh. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true ## ConnectionState Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) ## Endpoint Connection 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)** ### displayName Name as presented for humans. Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ### isDefault Indicate whatever we are a default endpoint. Default means buildin. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false ### isDummy Indicate whatever we are a dummy endpoint. Dummy endpoints are used duiring construction of the endpoint mesh. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false ### toStringAttributes Mapping of properties used in toString. Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### connectionNamesWithStates #### Parameters * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{includeRuntimeInfo:true}`) * `options.includeRuntimeInfo` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** ### isIn Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false ### isOut Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false ### direction Deliver data flow direction. Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** delivers data flow direction 'in', 'out', 'inout' or undefined ### jsonAttributes Additional attributes to present in json output. ### toJSONWithOptions #### Parameters * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ### hasInterceptors Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is at least one interceptor assigned ### connectable Can we form a connection to the other side. in to out and out to in. #### Parameters * `other` **[Endpoint](#endpoint)** Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if we can be connected to the other endpoint ### hasConnections Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is at least one connection ### isConnected Are we connected to a endpoint. #### Parameters * `other` **[Endpoint](#endpoint)** to check for the connection Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is a connection to the other endpoint ### openConnection Actually start with the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call from back call from the other side ### closeConnection Actually stop the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call from back call from the other side ### openConnections Opens all connections. ### closeConnections Closes all connections. ### connections Returns **Iterable<[Endpoint](#endpoint)>** ### addConnection #### Parameters * `connection` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side ### removeConnection Actually stop the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side ### getConnectionState Deliver state for a given connection. #### Parameters * `other` **[Endpoint](#endpoint)** Returns **[ConnectionState](#connectionstate)** ### setConnectionState Set state for a given connection. #### Parameters * `other` **[Endpoint](#endpoint)** * `state` **[ConnectionState](#connectionstate)** ### didConnect #### Parameters * `endpoint` **[Endpoint](#endpoint)** * `other` **[Endpoint](#endpoint)** ## isEndpoint Check for Endpoint. ### Parameters * `object` **any** to be checked Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if object is an Endpoint ## instanciateInterceptors Instanciate interceptors from its definitions. ### Parameters * `interceptors` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\ | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** * `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** ## MultiConnectionEndpoint **Extends ReceivableEndpoint** Multiple connection endpoint. Can hold several connections. ### Parameters * `name` * `owner` * `options` ### getConnectionState Deliver connection state. #### Parameters * `other` **[Endpoint](#endpoint)** Returns **any** our state for the connection to other ### setConnectionState Set connection state. #### Parameters * `other` **[Endpoint](#endpoint)** * `state` **any** for the connection to other ### removeConnection Actually stop the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)??** true if this is the call form back call from the other side ### isConnected Check connectivity. #### Parameters * `other` **[Endpoint](#endpoint)** Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if we are connected with other ### connections All connections ## connections Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[Endpoint](#endpoint), any> ## MultiSendEndpoint **Extends MultiConnectionEndpoint** Multiple Sending Endpoint. Can hold several connections. Back connections to any further endpoints will not be established ### 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)** * `options.connected` **[Endpoint](#endpoint)?** where te requests are delivered to * `options.didConnect` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** called after receiver is present ### isOut We are always *out* Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true ## ReceivableEndpoint **Extends 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)** ### isIn Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true is receive function is present ## ReceiveEndpointDefault **Extends ReceiveEndpoint** Receive Endpoint acting as a default endpoints. ### isDefault We are a default endpoint Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true ## ReceiveEndpointSelfConnectedDefault **Extends ReceiveEndpointDefault** Receiving endpoint wich can also send to itself. ### removeConnection Actually stop the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side ## ReceiveEndpoint **Extends MultiConnectionEndpoint** Receiving Endpoint. Can receive from several endpoints. By default a dummy rejecting receiver is assigned ### 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)** * `options.receive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** reciever function * `options.connected` **[Endpoint](#endpoint)?** sending side ### isIn We are always *in* Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true ## SendEndpointDefault **Extends SendEndpoint** Send Endpoint acting as a default endpoints. ### isDefault We are a default endpoint. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true ## SendEndpoint **Extends ReceivableEndpoint** Sending Endpoint. Can only hold one connection. Back connections to any further endpoints will not be established ### 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)** ### isOut We are always *out* Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true ### addConnection Add a connection. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side ### removeConnection Actually stop the communication. #### Parameters * `other` **[Endpoint](#endpoint)** * `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side ## SendReceiveEndpoint **Extends SendEndpoint** bi directional endpint ### isIn Always receiving. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true # install With [npm](http://npmjs.org) do: ```shell npm install kronos-endpoint ``` # license BSD-2-Clause