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
• getFragments
• 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>

A promise that resolves when the database is closed.

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>

A promise resolving to true if the operation was committed, false otherwise.

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>

A promise resolving to true if the snapshot was committed, false otherwise.

Overrides

Db.commitSnapshot

---

getCommittedOpVersion

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

Retrieves the committed version of an operation if it exists.

Parameters

Name	Type
id	string
to	number
op	IOp<object>

Returns

Promise<undefined | number>

Inherited from

Db.getCommittedOpVersion

---

getDocument

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

Retrieves document information by ID.

Parameters

Name	Type
roomId	string

Returns

Promise<undefined | IDocument>

A promise resolving to the document info or undefined/null if not found.

Overrides

Db.getDocument

---

getFragment

▸ getFragment(roomId, fragmentId): Promise<undefined | S>

Retrieves a specific fragment of a document by ID.

Parameters

Name	Type
roomId	string
fragmentId	string

Returns

Promise<undefined | S>

A promise resolving to the fragment data or undefined/null if not found.

Overrides

Db.getFragment

---

getFragments

▸ getFragments(roomId): Promise<{ [key: string]: S; }>

Retrieves multiple fragments of a document by ID.

Parameters

Name	Type
roomId	string

Returns

Promise<{ [key: string]: S; }>

} A promise resolving to an object mapping fragment IDs to their data.

Overrides

Db.getFragments

---

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>[]>

A promise resolving to an array of operations.

Overrides

Db.getOps

---

getSnapshot

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

Retrieves the snapshot of a document by ID.

Parameters

Name	Type
roomId	string

Returns

Promise<undefined | ISnapshot<S>>

A promise resolving to the snapshot or undefined/null if not found.

Overrides

Db.getSnapshot