Class Database<T>

Type parameters

T

Hierarchy

EventEmitter
- Database

Index

Constructors

constructor

Properties

onContactListChange

Accessors

Constructors

constructor

new Database<T>(dbname: string): Database<T>

Overrides EventEmitter.constructor
- Defined in src/db.ts:46
Create a new database for a given Automerge document type.

Type parameters
- T
Parameters
- dbname: string
  
  The name of the database
Returns Database<T>

Properties

onContactListChange

onContactListChange: Function

Accessors

all

get all(): FreezeObject<IContact>[]

- Defined in src/db.ts:82
Returns FreezeObject<IContact>[]

devices

get devices(): IDevice[]

- Defined in src/db.ts:94
Returns IDevice[]

documents

get documents(): string[]

- Defined in src/db.ts:68
Get an array of all document ids

Returns string[]

root

get root(): FreezeObject<ContactList>
set root(doc: FreezeObject<ContactList>): void

- Defined in src/db.ts:90
Returns FreezeObject<ContactList>
- Defined in src/db.ts:86
Parameters
- doc: FreezeObject<ContactList>
Returns void

settings

get settings(): any

- Defined in src/db.ts:74
Returns any

Methods

addContact

addContact(key: string, name: string): Promise<string>

- Defined in src/db.ts:247
Add a contact.

Parameters
- key: string
- name: string
Returns Promise<string>

addDevice

addDevice(key: string): Promise<any>

- Defined in src/db.ts:228
Parameters
- key: string
Returns Promise<any>

addDocument

addDocument(docId: string, changeFn: ChangeFn<T | System>): Promise<string>

- Defined in src/db.ts:357
Parameters
- docId: string
- changeFn: ChangeFn<T | System>
Returns Promise<string>

change

change<J>(docId: string, changeFn: ChangeFn<J>, message?: string): Promise<void>

- Defined in src/db.ts:197
Make a change to a document.

Type parameters
- J
Parameters
- docId: string
  
  The document ID
- changeFn: ChangeFn<J>
  
  The Automerge change function to change the document.
- Optional message: string
Returns Promise<void>

changeContactList

changeContactList(changeFn: ChangeFn<ContactList>): Promise<void>

- Defined in src/db.ts:314
Parameters
- changeFn: ChangeFn<ContactList>
Returns Promise<void>

changeRoot

changeRoot(changeFn: ChangeFn<ContactList>): Promise<void>

- Defined in src/db.ts:78
Parameters
- changeFn: ChangeFn<ContactList>
Returns Promise<void>

deleteDevice

deleteDevice(id: string): Promise<void>

- Defined in src/db.ts:220
Parameters
- id: string
Returns Promise<void>

destroy

destroy(): Promise<void>

- Defined in src/db.ts:342
Returns Promise<void>

error

error(err: any): void

- Defined in src/db.ts:119
Parameters
- err: any
Returns void

getBlob

getBlob(id: string): Promise<Uint8Array>

- Defined in src/db.ts:104
Parameters
- id: string
Returns Promise<Uint8Array>

getContactByDiscoveryKey

getContactByDiscoveryKey(discoveryKey: string): IContact

- Defined in src/db.ts:329
Get contact by discovery key

Parameters
- discoveryKey: string
  
  the discovery key for this contact
Returns IContact

getContactById

getContactById(id: string): IContact

- Defined in src/db.ts:318
Parameters
- id: string
Returns IContact

getContacts

getContacts(): IContact[]

- Defined in src/db.ts:114
Returns IContact[]

getDocument

getDocument(docId: string): FreezeObject<unknown>

- Defined in src/db.ts:161
Parameters
- docId: string
Returns FreezeObject<unknown>

getDocumentIds

getDocumentIds(contact: IContact): string[]

- Defined in src/db.ts:186
Parameters
- contact: IContact
Returns string[]

hasBlob

hasBlob(id: string): Promise<boolean>

- Defined in src/db.ts:99
Parameters
- id: string
Returns Promise<boolean>

isConnected

isConnected(contact: IContact): boolean

- Defined in src/db.ts:177
Is this contact currently connected to us? i.e., currently online and we have an open connection with them

Parameters
- contact: IContact
  
  The contact object
Returns boolean

If the contact is currently connected

onDisconnect

onDisconnect(docId: any, peerId: any): Promise<void>

- Defined in src/db.ts:151
When a peer disconnects, call this function

Parameters
- docId: any
  
  A unique identifer for the document
- peerId: any
  
  A unique identifier for the peer (should be the same called in onPeerConnect)
Returns Promise<void>

onPeerConnect

onPeerConnect(peerId: string, docId: string, send: Function): ReceiveSyncMsg

- Defined in src/db.ts:131
When a peer connects, call this function

Parameters
- peerId: string
- docId: string
- send: Function
Returns ReceiveSyncMsg

open

open(): Promise<any[]>

- Defined in src/db.ts:270
Open the database. This is called automatically when you create the instance and you don't need to call it.

Returns Promise<any[]>

When the database has been opened

save

save(docId: string): Promise<[string, void]>

- Defined in src/db.ts:349
Parameters
- docId: string
Returns Promise<[string, void]>

saveBlob

saveBlob(id: string, data: Uint8Array): PromiseExtended<string>

- Defined in src/db.ts:110
Parameters
- id: string
- data: Uint8Array
Returns PromiseExtended<string>

Generated using TypeDoc