docs: add info about addTransactionCapability

This commit is contained in:
Adhiraj Singh
2022-05-22 20:41:00 +05:30
parent 9a39a46398
commit c5d488f1c6

View File

@@ -15,6 +15,13 @@ const KEY_MAP: { [T in keyof SignalDataTypeMap]: string } = {
'sender-key-memory': 'senderKeyMemory'
}
/**
* Adds DB like transaction capability (https://en.wikipedia.org/wiki/Database_transaction) to the SignalKeyStore,
* this allows batch read & write operations & improves the performance of the lib
* @param state the key store to apply this capability to
* @param logger logger to log events
* @returns SignalKeyStore with transaction capability
*/
export const addTransactionCapability = (state: SignalKeyStore, logger: Logger): SignalKeyStoreWithTransaction => {
let inTransaction = false
let transactionCache: SignalDataSet = { }