Braid Client

WebSocket-based key-value synchronization.

See also:

• Server
• MessagePack Definitions

API

Table of Contents

• ConnectionError
  • Parameters
• CredentialsError
  • Parameters
• SubscribeError
  • Parameters
• EventSubscribeError
  • Parameters
• PublishError
  • Parameters
• ServerRequestError
  • Parameters
• Client
  • data
  • setReconnectHandler
    • Parameters
  • open
    • Parameters
  • close
    • Parameters
  • sendCredentials
    • Parameters
  • subscribe
    • Parameters
  • sendSubscribeRequest
    • Parameters
  • unsubscribe
    • Parameters
  • addServerEventListener
    • Parameters
  • sendEventSubscribeRequest
    • Parameters
  • removeServerEventListener
    • Parameters
  • startPublishing
    • Parameters
  • publish
    • Parameters
  • sendPublishRequest
    • Parameters
  • stopPublishing
    • Parameters

ConnectionError

Extends Error

Class representing a connection error

Parameters

• message string

CredentialsError

Extends Error

Class representing a credentials error

Parameters

• message string
• code number

SubscribeError

Extends Error

Class representing a subscribe error

Parameters

• itemKey string
• message string
• code number

EventSubscribeError

Extends Error

Class representing an event subscribe error

Parameters

• itemName string
• message string
• code number

PublishError

Extends Error

Class representing an publishing error

Parameters

• itemName string
• message string
• code number

ServerRequestError

Extends Error

Class representing an error that interupts a pending server request, for example if a connection closes prematurely

Parameters

• message string
• code number

Client

Extends EventEmitter

Class representing a Braid Client

data

Primary data object. Like a native JS Map but with 'set' and 'delete' events.

setReconnectHandler

Set the reconnect handler. The handler determines if the reconnect should continue.

Parameters

• func function (Object): boolean

Returns void

open

Connects to a server.

Parameters

• address string Websocket URL of the server
• credentials Object? Credentials to send

Returns Promise<void>

close

Close connection to server.

Parameters

• code number? Websocket close reason code to send to the server
• reason string? Websocket close reason to send to the server

Returns Promise<void>

sendCredentials

Send credentials to a server with an open connection.

Parameters

• credentials Object? Credentials to send

Returns Promise<void>

subscribe

Subscribe to updates on a key.

Parameters

• key string Key to request updates on

Returns Promise<void>

sendSubscribeRequest

Send subscribe request to server

Parameters

• key string Key to request updates on

Returns Promise<void>

unsubscribe

Unsubscribe from updates on a key. If the callback parameter is not provided, all callbacks are unsubscribed.

Parameters

• key string Key to stop updates on

Returns Promise<void>

addServerEventListener

Subscribe to a server event

Parameters

• name string Name of the event to listen for
• callback function (): void?

Returns Promise<void>

sendEventSubscribeRequest

Send event subscribe request to server

Parameters

• name string Name of the event to listen for

Returns Promise<void>

removeServerEventListener

Unsubscribe from a server event. If the callback parameter is not provided, all callbacks are unsubscribed.

Parameters

• name string Name of the event to stop listening
• callback function (any): void?

Returns Promise<void>

startPublishing

Start publishing to a receiver

Parameters

• name string Name of the receiver to start publishing to

Returns Promise<void>

publish

Publish message to a receiver

Parameters

• name string Name of the receiver
• message any Value to publish, should not contain undefined values

Returns Promise<void>

sendPublishRequest

Send event subscribe request to server

Parameters

• name string Name of the event to listen for

Returns Promise<void>

stopPublishing

Stop publishing to a receiver.

Parameters

• name string Name of the receiver to stop publishing to

Returns Promise<void>