a mongoose plugin that allows you to soft delete documents and restore them (for JS & TS)
npm install @mahdad/soft-delete-plugin-mongoose> a mongoose plugin that allows you to soft delete documents and restore them in MongoDB (for JS & TS)
- Soft delete your MongoDB documents and restore them
- JS and TS
``sh`
npm install @mahdad/soft-delete-plugin-mongoose
Javascript Version
`js
const mongoose = require("mongoose");
const { softDeletePlugin } = require("@mahdad/soft-delete-plugin-mongoose");
const Schema = mongoose.Schema;
const TestSchema = new Schema({
name: String,
lastName: String,
});
TestSchema.plugin(softDeletePlugin);
const TestModel = mongoose.model("Test", TestSchema);
const test = new TestModel({ name: "hello", lastName: "world" });
/ returns an object containing the number of softDeleted elements /
/*
{deleted: number}
*/
/*
the argument options is optional
*/
const options = { validateBeforeSave: false };
const deleted = await TestModel.softDelete(
{ _id: test._id, name: test.name },
options
);
/**
const deleted = await Test.softDelete({ _id: test._id, name: test.name }); is also valid
**/
/ returns an object containing the number of restored elements /
/*
{restored: number}
*/
const restored = await TestModel.restore({ _id: test._id, name: test.name });
/ returns all deleted elements /
const deletedElements = await TestModel.findDeleted();
/ returns all available elements (not deleted) /
const availableElements = await TestModel.find();
/ returns one available element (not deleted) /
const availableElements = await TestModel.findOne();
/ update if is not be deleted (not deleted) /
const availableElements = await TestModel.findOneAndUpdate();
/ counts all available elements (not deleted) /
const countAvailable = await TestModel.count();
/ findById returns the document whether deleted or not /
`
Typescript Version
`ts
import * as mongoose from 'mongoose';
import { softDeletePlugin, SoftDeleteModel } from '@mahdad/soft-delete-plugin-mongoose';
interface Test extends mongoose.Document {
name: string;
lastName: string;
}
const TestSchema = new mongoose.Schema({
name: String,
lastName: String
});
TestSchema.plugin(softDeletePlugin);
// two different ways of implementing model depending on technology used
// 1st way
const testModel = mongoose.model
//2nd way (nestjs way)
constructor(@InjectModel('Test') private readonly testModel: SoftDeleteModel
const test = await new this.testModel({name: 'hello', lastName: 'world'});
/ returns an object containing the number of softDeleted elements /
/*
{deleted: number}
*/
/*
the argument options is optional
*/
const options = { validateBeforeSave: false };
const deleted = await this.testModel.softDelete({ _id: test._id, name: test.name }, options);
/**
const deleted = await Test.softDelete({ _id: test._id, name: test.name }); is also valid
**/
/ returns an object containing the number of restored elements /
/*
{restored: number}
*/
const restored = await this.testModel.restore({ _id: test._id, name: test.name });
/ returns all deleted elements /
const deletedElements = await this.testModel.findDeleted();
/ returns all available elements (not deleted) /
const availableElements = await this.testModel.find();
/ returns one available element (not deleted) /
const availableElements = await this.testModel.findOne();
/ update if is not be deleted (not deleted) /
const availableElements = await this.testModel.findOneAndUpdate();
/ counts all available elements (not deleted) /
const countAvailable = await this.testModel.count();
/ findById returns the document whether deleted or not /
``
š¤ MahdadGhasemian
- Github: @MahdadGhasemian
- LinkedIn: @nourkaroui
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Give a STAR if this project helped you!
- Copyright Ā© 2021 MahdadGhasemian.
- This project is MIT licensed.
---
_This README was generated with by readme-md-generator_