Skip to content

Commit

Permalink
Merge pull request #60 from sg-milad/docs/update
Browse files Browse the repository at this point in the history
docs: add soft delete to the docs
  • Loading branch information
zaro committed Jun 29, 2024
2 parents 645b083 + 3851077 commit 6992031
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/controllers.md
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

0 comments on commit 6992031

Please sign in to comment.