Mongoose Soft Delete Plugin
Mongoose plugin that enables soft deletion of Models/Documents.
This plugin is based on the work of Yi.
What's Different
In the original plugin, models were deleted with a date reference only. This version takes that and uses a Boolean flag to to mark models deleted/restored. Adds deletedAt
field to record when a document was deleted. Additionally, it removes a lot of overhead from the original code and doesn't use Coffeescript.
Also checkout Mongoose Delete by Sanel Deljkic.
License
This plugin is licensed under the MIT license and can ve viewed in the LICENSE file.
Installation
Install using npm
npm install mongoose-softdelete --save
Tests
IMPORTANT: You need to have MongoDB running to run tests
npm test
Usage
models/test.js
const mongoose = Schema = mongooseSchema soft_delete = ; const TestSchema = somefield: type: String default: 'Hello World!' ; TestSchema; mongoose;
controllers/test.js
const Test = mongoose;const test = ; test; test; // chainable query method// defaults to true unless specifiedTest;
Typescript
;; ; TestSchema.pluginsoftdelete; ;; test1.softdelete; // chainable query method// defaults to true unless specifiedTest.find as unknown as ISoftDeletedDocumentQuery.isDeletedfalse
Built with love in Dhaka, Bangladesh by Riyadh Al Nur