crud-api-express 1.2.1 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +7 -7
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -29,19 +29,19 @@ This project provides a flexible and reusable CRUD (Create, Read, Update, Delete
|
|
|
29
29
|
- [Usage](#usage)
|
|
30
30
|
- [API](#api)
|
|
31
31
|
- [Options](#options)
|
|
32
|
-
- [Examples](#examples)
|
|
33
|
-
- [Contributing](#contributing)
|
|
34
32
|
- [License](#license)
|
|
35
33
|
|
|
34
|
+
|
|
35
|
+
|
|
36
36
|
---
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Introduction
|
|
39
39
|
|
|
40
40
|
The `CrudController` class simplifies the creation of RESTful APIs in Node.js applications using MongoDB. It abstracts away common CRUD operations, error handling, middleware integration, and supports custom routes and aggregation pipelines.
|
|
41
41
|
|
|
42
42
|
---
|
|
43
43
|
|
|
44
|
-
##
|
|
44
|
+
## Usage
|
|
45
45
|
|
|
46
46
|
Here's a basic example of how to use in Es module `CrudController`:
|
|
47
47
|
|
|
@@ -224,7 +224,7 @@ mongoose
|
|
|
224
224
|
|
|
225
225
|
---
|
|
226
226
|
|
|
227
|
-
##
|
|
227
|
+
## API
|
|
228
228
|
|
|
229
229
|
### `getRouter(): Router`
|
|
230
230
|
Returns the Express Router instance configured with CRUD routes.
|
|
@@ -243,7 +243,7 @@ Returns the Express Router instance configured with CRUD routes.
|
|
|
243
243
|
]
|
|
244
244
|
```
|
|
245
245
|
|
|
246
|
-
##
|
|
246
|
+
## Options
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
### `CrudOptions<T>`
|
|
@@ -274,7 +274,7 @@ Returns the Express Router instance configured with CRUD routes.
|
|
|
274
274
|
- **`limit`** → Number of results per page.
|
|
275
275
|
|
|
276
276
|
|
|
277
|
-
##
|
|
277
|
+
## License
|
|
278
278
|
|
|
279
279
|
This project is licensed under the **ISC License**.
|
|
280
280
|
|