From 3851077445b106da77c6af53291da0a9203d6782 Mon Sep 17 00:00:00 2001 From: milad Date: Wed, 26 Jun 2024 15:51:25 +0330 Subject: [PATCH] docs: add soft delete to the docs --- docs/controllers.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/controllers.md b/docs/controllers.md index 28fc5703..ce3d8c5e 100644 --- a/docs/controllers.md +++ b/docs/controllers.md @@ -394,6 +394,7 @@ Also you can specify what routes should be excluded or what routes whould be use maxLimit?: number; cache?: number | false; alwaysPaginate?: boolean; + softDelete?: boolean; }, ... }) @@ -632,6 +633,18 @@ _Optional_ Either or not always return an object with paginated data. Can be defined [globally](#global-options) as well. +#### softDelete + +```typescript +{ + softDelete: true, +} +``` + +_Optional_ + +A boolean value indicating whether the item should be soft-deleted. If set to true, the item will be soft-deleted instead of being permanently removed from the database. + ### dto ```typescript