Baseline Protocol
v1.0.0
v1.0.0
  • Welcome
  • Basics
    • Introduction
    • Architecture
    • Glossary
    • FAQ
  • Community
    • Open Source Community
      • Contributors
      • Members
    • Community Leaders
      • Core Developers
      • General Assembly
  • GOVERNANCE
    • Overview
    • Project Governance Board
    • Technical Steering Committee
  • Source Code
    • Packages
      • API
      • Baseline
      • CCSM
      • Identity
      • Privacy
      • Vault
      • Types
    • Baseline Process
    • Developer Resources
  • Standard
    • Overview
    • CORE Specification
    • API Specification
    • CCSM Specification
  • Reference Implementations
    • Overview
    • BRI-1
      • Base Example
    • BRI-2
  • Connectors
    • SAP/Microsoft Dynamics
    • Google Sheets/Microsoft Dynamics
    • MSFT Excel Connector
  • Deprecated Work
    • Overview
    • Radish34 - DEPRECATED
      • Radish34 Explained - DEPRECATED
      • Interactive Demo - DEPRECATED
      • Workflow - DEPRECATED
      • Key Diagrams - DEPRECATED
Powered by GitBook
On this page
  • @baseline-protocol/messaging
  • Installation
  • Building
  • Interfaces
  • Supported Providers & Protocols

Was this helpful?

Export as PDF
  1. Source Code
  2. Packages

Vault

PreviousPrivacyNextTypes

Last updated 3 years ago

Was this helpful?

@baseline-protocol/messaging

Baseline core messaging package.

​ is currently the default point-to-point messaging provider and the recommended way for organizations to exchange secure protocol messages. NATS was chosen due to its high-performance capabilities, community/enterprise footprint, interoperability with other systems and protocols (i.e. and MQTT) and its decentralized architecture.‌

Installation

npm install @baseline-protocol/vault(npm package soon to be published)

Building

You can build the package locally with npm run build.‌

Interfaces

IMessagingService

connect(): Promise<any>;
disconnect(): Promise<void>;
getSubscribedSubjects(): string[];
isConnected(): boolean;
publish(subject: string, payload: any, reply?: string, recipientId?: string, senderId?: string): Promise<void>;
request(subject: string, timeout: number, data?: any): Promise<any | void>;
subscribe(subject: string, callback?: (msg: any, err?: any) => void, myId?: string): Promise<any>;
unsubscribe(subject: string);
flush(): Promise<void>;

Supported Providers & Protocols

The following messaging providers are available:‌

  • NATS

  • Whisper

NATS
Kafka