Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add soft delete to the docs #60

Merged
merged 1 commit into from
Jun 29, 2024
Merged

docs: add soft delete to the docs #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/controllers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
},
...
})
Expand Down Expand Up @@ -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
Expand Down