Class: MemoryDb<S, T>

Type parameters

Name	Type
S	unknown
T	unknown

Hierarchy

• Db<S, T>

  ↳ MemoryDb

Table of contents

Constructors

• constructor

Methods

• close
• commitOp
• commitSnapshot
• getCommittedOpVersion
• getDocument
• getFragment
• getOps
• getSnapshot

Constructors

constructor

• new MemoryDb<S, T>()

Type parameters

Name	Type
S	unknown
T	unknown

Inherited from

Db.constructor

Methods

close

▸ close(): Promise<void>

Closes the database connection.

Returns

Promise<void>

Overrides

Db.close

---

commitOp

▸ commitOp(id, op, document): Promise<boolean>

Commits an operation to the database.

Parameters

Name	Type
id	string
op	IOp<T>
document	IDocument

Returns

Promise<boolean>

Overrides

Db.commitOp

---

commitSnapshot

▸ commitSnapshot(roomId, snapshot): Promise<boolean>

Commits a snapshot to the database.

Parameters

Name	Type
roomId	string
snapshot	ICommitSnapshot<S>

Returns

Promise<boolean>

Overrides

Db.commitSnapshot

---

getCommittedOpVersion

▸ getCommittedOpVersion(id, to, op): Promise<null | number>

Retrieves the committed version of an operation if it exists.

Parameters

Name	Type
id	string
to	number
op	IOp<object>

Returns

Promise<null | number>

Inherited from

Db.getCommittedOpVersion

---

getDocument

▸ getDocument(roomId): Promise<null | IDocument>

Retrieves document information by ID.

Parameters

Name	Type
roomId	string

Returns

Promise<null | IDocument>

Overrides

Db.getDocument

---

getFragment

▸ getFragment(roomId, fragmentId): Promise<null | { data: null | S ; version: number }>

Retrieves a specific fragment of a document by ID.

Parameters

Name	Type
roomId	string
fragmentId	string

Returns

Promise<null | { data: null | S ; version: number }>

Overrides

Db.getFragment

---

getOps

▸ getOps(roomId, fromVersion, toVersion?): Promise<IOp<T>[]>

Retrieves operations between two versions (inclusive of 'from', exclusive of 'to').

Parameters

Name	Type
roomId	string
fromVersion	number
toVersion?	number

Returns

Promise<IOp<T>[]>

Overrides

Db.getOps

---

getSnapshot

▸ getSnapshot(roomId): Promise<null | ISnapshot<S>>

Retrieves the snapshot of a document by ID.

Parameters

Name	Type
roomId	string

Returns

Promise<null | ISnapshot<S>>

Overrides

Db.getSnapshot