Class VoidMergeClient

A VoidMergeClient can talk to VoidMerge servers.

Index

Constructors

Methods

getThisPeerHash insert select send setApiToken setAppAuthData setMessageCallback setShortCache

Constructors

constructor

new VoidMergeClient(
    multiSign: VmMultiSign,
    serverUrl: URL,
    context: VmHash,
): VoidMergeClient
Construct a new VoidMergeClient.
Parameters
- multiSign: VmMultiSign
- serverUrl: URL
- context: VmHash
Returns VoidMergeClient
- Defined in void-merge-client.ts:18

Methods

getThisPeerHash

getThisPeerHash(): Promise<VmHash>
Get this node's "peerHash" at which messages may be sent to this node.

Returns Promise<VmHash>
- Defined in void-merge-client.ts:85

insert

insert(insert: VmObj): Promise<void>
Insert data into a VoidMerge server instance.
Parameters
- insert: VmObj
Returns Promise<void>
- Defined in void-merge-client.ts:104

select

select(select: VmSelect): Promise<VmSelectResponse>
Parameters
- select: VmSelect
Returns Promise<VmSelectResponse>
- Defined in void-merge-client.ts:112

send

send(peerHash: VmHash, data: Uint8Array): Promise<void>
Send a message to a remote peer.
Parameters
- peerHash: VmHash
- data: Uint8Array
Returns Promise<void>
- Defined in void-merge-client.ts:96

setApiToken

setApiToken(token: VmHash): void
If you have an invite or admin api token, specify it here.
Parameters
- token: VmHash
Returns void
- Defined in void-merge-client.ts:52

setAppAuthData

setAppAuthData(app: any): void
Parameters
- app: any
Returns void
- Defined in void-merge-client.ts:68

setMessageCallback

setMessageCallback(cb: (msg: VmMsg) => void): void
Set a message callback for handling incoming message data.
Parameters
- cb: (msg: VmMsg) => void
Returns void
- Defined in void-merge-client.ts:75

setShortCache

setShortCache(shortCache: VmObjSignedShortCache): void
Set the ShortCache to use when fetching VmObjSigned data.

It is recommended to use the same short cache across all clients to ensure the memory usage is bounded for the entire application.
Parameters
- shortCache: VmObjSignedShortCache
Returns void
- Defined in void-merge-client.ts:62