albatross 3.4.2 → 3.5.0

package/index.d.ts

@@ -82,6 +82,7 @@ declare namespace albatross {
     collection<TSchema extends { _id: any }> (name: string): Collection<TSchema>
     grid (name?: string): Grid
     ping (timeout?: number): Promise<void>
+    transaction<T> (fn: (session: mongodb.ClientSession) => PromiseLike<T>): Promise<T>
     close (force?: boolean): Promise<void>
   }
 

package/lib/albatross.js

@@ -99,6 +99,23 @@ class Albatross {
     }
   }
 
+  async transaction (fn) {
+    const client = await this[kConnect]()
+    const session = client.startSession()
+
+    let result
+
+    try {
+      await session.withTransaction(async (...args) => {
+        result = await fn(...args)
+      })
+    } finally {
+      session.endSession()
+    }
+
+    return result
+  }
+
   async close (force) {
     if (this[kClient] == null) return
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "albatross",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "license": "MIT",
   "author": "Linus Unnebäck <linus@folkdatorn.se>",
   "repository": "LinusU/node-albatross",

package/readme.md

@@ -95,6 +95,26 @@ Send the `ping` command to the server, to check that the connection is still int
 
 Optionally accepts a timeout in milliseconds.
 
+#### `.transaction(fn): Promise`
+
+Runs a provided function within a transaction, retrying either the commit operation or entire transaction as needed (and when the error permits) to better ensure that the transaction can complete successfully.
+
+Example:
+
+```js
+const user = db.collection('user')
+
+const result = await db.transaction(async (session) => {
+    await user.insert({ name: 'Linus', born: 1992 }, { session })
+    await user.insert({ name: 'Steve', born: 1955 }, { session })
+
+    return await user.findOne({ born: 1992 }, { session })
+})
+
+console.log('Hello ' + result.name)
+//=> Hello Linus
+```
+
 #### `.close(): Promise<void>`
 
 Closes the connection to the server.