crud-api-express 1.2.1 → 1.2.3

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +8 -10
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "crud-api-express",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "type": "module",
5
5
  "description": "",
6
6
  "main": "dist/index.js",
package/readme.md CHANGED
@@ -3,7 +3,6 @@
3
3
  ![npm](https://img.shields.io/npm/v/crud-api-express)
4
4
  ![downloads](https://img.shields.io/npm/dm/crud-api-express)
5
5
  ![license](https://img.shields.io/npm/l/crud-api-express)
6
- ![dependencies](https://img.shields.io/librariesio/release/npm/crud-api-express)
7
6
  ![made-with-node](https://img.shields.io/badge/Made%20with-Node.js-green)
8
7
  ![made-with-typescript](https://img.shields.io/badge/Made%20with-TypeScript-blue)
9
8
  ![express](https://img.shields.io/badge/Express.js-000000?style=flat&logo=express&logoColor=white)
@@ -18,9 +17,8 @@ Install the package using npm:
18
17
  ```bash
19
18
  npm install crud-api-express
20
19
  ```
21
-
22
20
  This project provides a flexible and reusable CRUD (Create, Read, Update, Delete) API controller for MongoDB using Express.js and Mongoose.
23
- ---
21
+
24
22
 
25
23
  ## 📌 Table of Contents
26
24
 
@@ -29,19 +27,19 @@ This project provides a flexible and reusable CRUD (Create, Read, Update, Delete
29
27
  - [Usage](#usage)
30
28
  - [API](#api)
31
29
  - [Options](#options)
32
- - [Examples](#examples)
33
- - [Contributing](#contributing)
34
30
  - [License](#license)
35
31
 
32
+
33
+
36
34
  ---
37
35
 
38
- ## 🚀 Introduction
36
+ ## Introduction
39
37
 
40
38
  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
39
 
42
40
  ---
43
41
 
44
- ## 🔧 Usage
42
+ ## Usage
45
43
 
46
44
  Here's a basic example of how to use in Es module `CrudController`:
47
45
 
@@ -224,7 +222,7 @@ mongoose
224
222
 
225
223
  ---
226
224
 
227
- ## 📖 API
225
+ ## API
228
226
 
229
227
  ### `getRouter(): Router`
230
228
  Returns the Express Router instance configured with CRUD routes.
@@ -243,7 +241,7 @@ Returns the Express Router instance configured with CRUD routes.
243
241
  ]
244
242
  ```
245
243
 
246
- ## ⚙️ Options
244
+ ## Options
247
245
 
248
246
 
249
247
  ### `CrudOptions<T>`
@@ -274,7 +272,7 @@ Returns the Express Router instance configured with CRUD routes.
274
272
  - **`limit`** → Number of results per page.
275
273
 
276
274
 
277
- ## 📜 License
275
+ ## License
278
276
 
279
277
  This project is licensed under the **ISC License**.
280
278