@kronos-integration/service-swarm

Manage a set of remote services

API

Table of Contents

• PEERS_NAME_PREFIX
• PeersEndpoint
  • Parameters
  • Properties
• ServiceSwarm
  • endpointFactoryFromConfig
    • Parameters
  • name
• TOPIC_NAME_PREFIX
• TopicEndpoint
  • Parameters
  • Properties
• Topic
  • Parameters
  • Properties

PEERS_NAME_PREFIX

Endpoint name prefix for peers endpoints.

Type: string

PeersEndpoint

Extends MultiSendEndpoint

Endpoint to link against a swarm topic.

Parameters

• name string endpoint name

• owner Object owner of the endpoint

• options Object (optional, default {})

  • options.topic string defaults to endpoint name (without @see PEERS_NAME_PREFIX)

Properties

• topic Topic

ServiceSwarm

Extends Service

Swarm detecting sync service.

endpointFactoryFromConfig

On demand create topic endpoints.

Parameters

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

Returns Class TopicEndpoint if name starts with 'topic.'

name

Returns string 'swarm'

TOPIC_NAME_PREFIX

Endpoint name prefix for topic endpoints.

Type: string

TopicEndpoint

Extends MultiSendEndpoint

Endpoint to link against a swarm topic.

Parameters

• name string endpoint name

• owner Object owner of the endpoint

• options Object (optional, default {})

  • options.topic string defaults to endpoint name (without @see TOPIC_NAME_PREFIX)

Properties

• topic Topic

Topic

Parameters

• service ServiceSwarm
• name string
• options Object (optional, default {})

Properties

• service ServiceSwarm
• name string
• options Object
• key Buffer
• topicEndpoints Set<TopicEndppoint>
• peerEndpoints Set<PeerEndpoint>

install

With npm do:

npm install @kronos-integration/service-swarm

license

BSD-2-Clause