albatross 3.6.0 → 3.7.0

package/index.d.ts

@@ -26,6 +26,10 @@ interface UpdateManyOptions extends Omit<mongodb.UpdateManyOptions, 'hint'> {
   hint?: string | object
 }
 
+interface FindOneAndDeleteOption<T> extends Omit<mongodb.FindOneAndDeleteOption<T>, 'hint'> {
+  hint?: string | object
+}
+
 declare function albatross (uri: string): albatross.Albatross
 
 declare namespace albatross {
@@ -71,6 +75,11 @@ declare namespace albatross {
     deleteOne (filter: mongodb.FilterQuery<TSchema>, options?: mongodb.CommonOptions & { bypassDocumentValidation?: boolean, hint?: string | object }): Promise<0 | 1>
     deleteMany (filter: mongodb.FilterQuery<TSchema>, options?: mongodb.CommonOptions & { hint?: string | object }): Promise<number>
 
+    findOneAndDelete (filter: mongodb.FilterQuery<TSchema>, options?: WithoutProjection<FindOneAndDeleteOption<TSchema>>): Promise<TSchema | null>
+    findOneAndDelete<TKey extends keyof TSchema> (filter: mongodb.FilterQuery<TSchema>, options: SpecificProjection<FindOneAndDeleteOption<TSchema>, { [key in TKey]: 1 | true } & { _id: 0 | false }>): Promise<Pick<TSchema, TKey> | null>
+    findOneAndDelete<TKey extends keyof TSchema> (filter: mongodb.FilterQuery<TSchema>, options: SpecificProjection<FindOneAndDeleteOption<TSchema>, { [key in TKey]: 1 | true } & { _id?: 1 | true }>): Promise<Pick<TSchema, '_id' | TKey> | null>
+    findOneAndDelete (filter: mongodb.FilterQuery<TSchema>, options?: FindOneAndDeleteOption<TSchema>): Promise<object | null>
+
     aggregate (pipeline: object[], options?: mongodb.CollectionAggregationOptions): Promise<object[]>
 
     createIndex (fieldOrSpec: string | any, options?: mongodb.IndexOptions): Promise<string>

package/lib/collection.js

@@ -190,6 +190,20 @@ class Collection {
     }
   }
 
+  async findOneAndDelete (filter, opts) {
+    const db = await this.parent.db()
+
+    try {
+      this[kDebug]('findOneAndDelete(%o)', filter)
+      const res = await db.collection(this.name).findOneAndDelete(filter, opts)
+      this[kDebug](`reply OK ${res.value == null ? 0 : 1}`)
+      return res.value
+    } catch (err) {
+      this[kDebug]('reply ERR')
+      throw err
+    }
+  }
+
   async aggregate (pipeline, opts) {
     const db = await this.parent.db()
 

package/package.json

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

package/readme.md

@@ -185,6 +185,10 @@ Deletes a single document matching `filter`. Resolves with the number of documen
 
 Deletes multiple documents matching `filter`. Resolves with the number of documents deleted.
 
+#### `findOneAndDelete(filter[, opts]): Promise<object>`
+
+Finds a document and deletes it in one atomic operation.
+
 #### `aggregate(pipeline[, opts]): Promise<object[]>`
 
 Executes an aggregation framework pipeline against the collection. Resolves with the aggregated objects.