mime-types-lite 1.0.0 → 1.0.1

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 (4) hide show
  1. package/README.md +72 -1
  2. package/build/index.d.ts +136 -0
  3. package/{index.js → build/index.js} +132 -191
  4. package/package.json +69 -24
package/README.md CHANGED
@@ -2,7 +2,78 @@
2
2
 
3
3
  A collection of commonly used MIME types for applications. This package helps standardize MIME type handling in your project.
4
4
 
5
- ## Installation
5
+ ---
6
+
7
+ ### Requirements to Use the Package
8
+
9
+ - [NodeJS](https://nodejs.org/en)
10
+ - [npm](https://www.npmjs.com/)
11
+ - [TypeScript](https://www.typescriptlang.org/) (optional but recommended)
12
+
13
+ ---
14
+
15
+ ### 🚀 Installation
16
+
17
+ To install the package in your project, run:
6
18
 
7
19
  ```bash
8
20
  npm install mime-types-lite
21
+ ```
22
+
23
+ ---
24
+
25
+ ### 🛠️ Usage
26
+
27
+ 1. **Import the Constants:**
28
+
29
+ You can import all MIME type constants into your project:
30
+
31
+ ```javascript
32
+ import mimeTypesLite from 'mime-types-lite';
33
+
34
+ console.log(mimeTypesLite.JSON); // Outputs: application/json
35
+ ```
36
+
37
+ 2. **TypeScript Support:**
38
+
39
+ The package includes TypeScript types for strict type checking:
40
+
41
+ ```typescript
42
+ import mimeTypesLite, { MimeType } from 'mime-types-lite';
43
+
44
+ const pdfMimeType: MimeType = 'PDF';
45
+ console.log(mimeTypesLite[pdfMimeType]); // Outputs: application/pdf
46
+ ```
47
+
48
+ 3. **Example Usage in a Node.js Server:**
49
+
50
+ ```javascript
51
+ import mimeTypesLite from 'mime-types-lite';
52
+
53
+ const express = require('express');
54
+ const app = express();
55
+
56
+ app.get('/file', (req, res) => {
57
+ res.setHeader('Content-Type', mimeTypesLite.JSON);
58
+ res.send({ message: 'Hello, world!' });
59
+ });
60
+
61
+ app.listen(3000, () => console.log('Server running on port 3000'));
62
+ ```
63
+
64
+ ---
65
+
66
+ ### 📖 Author
67
+
68
+ <table>
69
+ <tr>
70
+ <td align="center">
71
+ <img src="https://avatars.githubusercontent.com/u/95298623?v=4" width="100px" alt="Moon">
72
+ <a href="https://github.com/montasim">
73
+ <br>
74
+ Ｍ♢ＮＴΛＳＩＭ
75
+ </br>
76
+ </a>
77
+ </td>
78
+ </tr>
79
+ </table>
package/build/index.d.ts ADDED
@@ -0,0 +1,136 @@
1
+ /**
2
+ * @fileoverview Defines the various MIME types used in the application.
3
+ * This module exports an object that contains the different MIME types
4
+ * the application can handle. These MIME types are used to identify the format of data being processed or served.
5
+ *
6
+ * @module constants/mimeTypes
7
+ * @version 1.0.0
8
+ * @license CC BY-NC-ND 4.0
9
+ *
10
+ * @contact Mohammad Montasim -Al- Mamun Shuvo
11
+ * @created 2025-01-28
12
+ * @contactEmail montasimmamun@gmail.com
13
+ * @contactGithub https://github.com/montasim
14
+ */
15
+ /**
16
+ * An object representing different MIME types.
17
+ * @enum {string}
18
+ */
19
+ declare const mimeTypesLite: Readonly<{
20
+ /** Document MIME Types */
21
+ /**
22
+ * MIME Type for PDF files.
23
+ * Example: The application generates an invoice as a `.pdf` file for download.
24
+ */
25
+ PDF: "application/pdf";
26
+ /**
27
+ * MIME Type for Markdown files.
28
+ * Example: Documentation files are stored and processed as `.md`.
29
+ */
30
+ MD: "text/markdown";
31
+ /**
32
+ * MIME Type for Plain Text files.
33
+ * Example: A log file is served as a `.txt` file.
34
+ */
35
+ TXT: "text/plain";
36
+ /**
37
+ * MIME Type for CSV files.
38
+ * Example: Exported reports are downloaded as `.csv` files.
39
+ */
40
+ CSV: "text/csv";
41
+ /** Image MIME Types */
42
+ /**
43
+ * MIME Type for JPEG images.
44
+ * Example: User profile pictures are uploaded and served as `.jpeg` images.
45
+ */
46
+ JPG: "image/jpeg";
47
+ /**
48
+ * MIME Type for PNG images.
49
+ * Example: A server serves `.png` files for website logos.
50
+ */
51
+ PNG: "image/png";
52
+ /**
53
+ * MIME Type for ICO images.
54
+ * Example: A server provides a `.ico` file as the favicon for a website.
55
+ */
56
+ ICO: "image/x-icon";
57
+ /**
58
+ * MIME Type for GIF images.
59
+ * Example: A messaging app serves `.gif` files for animated stickers.
60
+ */
61
+ GIF: "image/gif";
62
+ /**
63
+ * MIME Type for BMP images.
64
+ * Example: Specialized imaging software processes `.bmp` files.
65
+ */
66
+ BMP: "image/bmp";
67
+ /**
68
+ * MIME Type for TIFF images.
69
+ * Example: High-quality scanned documents are stored as `.tiff` files.
70
+ */
71
+ TIFF: "image/tiff";
72
+ /**
73
+ * MIME Type for SVG images.
74
+ * Example: A website serves `.svg` files for scalable vector icons.
75
+ */
76
+ SVG: "image/svg+xml";
77
+ /** Video MIME Types */
78
+ /**
79
+ * MIME Type for MP4 videos.
80
+ * Example: Video streaming services serve `.mp4` files for playback.
81
+ */
82
+ MP4: "video/mp4";
83
+ /** Audio MIME Types */
84
+ /**
85
+ * MIME Type for MP3 audio files.
86
+ * Example: Music streaming services provide `.mp3` files for playback.
87
+ */
88
+ MP3: "audio/mpeg";
89
+ /**
90
+ * MIME Type for WAV audio files.
91
+ * Example: A sound editing application processes `.wav` files.
92
+ */
93
+ WAV: "audio/wav";
94
+ /** Archive MIME Types */
95
+ /**
96
+ * MIME Type for ZIP archives.
97
+ * Example: A server offers `.zip` archives for software downloads.
98
+ */
99
+ ZIP: "application/zip";
100
+ /**
101
+ * MIME Type for RAR archives.
102
+ * Example: Compressed files are provided in `.rar` format for download.
103
+ */
104
+ RAR: "application/vnd.rar";
105
+ /** Web-related MIME Types */
106
+ /**
107
+ * MIME Type for JSON data.
108
+ * Example: REST APIs send data responses as JSON objects.
109
+ */
110
+ JSON: "application/json";
111
+ /**
112
+ * MIME Type for XML data.
113
+ * Example: SOAP APIs exchange data using `.xml` payloads.
114
+ */
115
+ XML: "application/xml";
116
+ /**
117
+ * MIME Type for JavaScript files.
118
+ * Example: A server delivers a `.js` file requested by a web browser.
119
+ */
120
+ JS: "application/javascript";
121
+ /**
122
+ * MIME Type for CSS files.
123
+ * Example: A server serves `.css` files to style a web page.
124
+ */
125
+ CSS: "text/css";
126
+ /**
127
+ * MIME Type for HTML files.
128
+ * Example: A server sends an `.html` file as a response to a browser request.
129
+ */
130
+ HTML: "text/html";
131
+ }>;
132
+ /**
133
+ * Type definition for available MIME types.
134
+ */
135
+ export type MimeType = keyof typeof mimeTypesLite;
136
+ export default mimeTypesLite;
package/{index.js → build/index.js} RENAMED
@@ -1,191 +1,132 @@
1
- /**
2
- * @fileoverview Defines the various MIME types used in the application.
3
- * This module exports an object that contains the different MIME types
4
- * the application can handle. These MIME types are used to identify the format of data being processed or served.
5
- *
6
- * @module constants/mimeTypes
7
- * @version 1.0.0
8
- * @license CC BY-NC-ND 4.0
9
- *
10
- * @contact Mohammad Montasim-Al-Mamun Shuvo
11
- * @created 2025-01-28
12
- * @contactEmail montasimmamun@gmail.com
13
- * @contactGithub https://github.com/montasim
14
- */
15
-
16
- /**
17
- * An object representing different MIME types.
18
- * @enum {string}
19
- */
20
- const mimeTypesConstants = Object.freeze({
21
- /** Document MIME Types */
22
-
23
- /**
24
- * MIME Type for PDF files.
25
- * Example: The application generates an invoice as a `.pdf` file for download.
26
- * @type {string}
27
- */
28
- PDF: 'application/pdf',
29
-
30
- /**
31
- * MIME Type for Markdown files.
32
- * Example: Documentation files are stored and processed as `.md`.
33
- * @type {string}
34
- */
35
- MD: 'text/markdown',
36
-
37
- /**
38
- * MIME Type for Plain Text files.
39
- * Example: A log file is served as a `.txt` file.
40
- * @type {string}
41
- */
42
- TXT: 'text/plain',
43
-
44
- /**
45
- * MIME Type for CSV files.
46
- * Example: Exported reports are downloaded as `.csv` files.
47
- * @type {string}
48
- */
49
- CSV: 'text/csv',
50
-
51
-
52
-
53
- /** Image MIME Types */
54
-
55
- /**
56
- * MIME Type for JPEG images.
57
- * Example: User profile pictures are uploaded and served as `.jpeg` images.
58
- * @type {string}
59
- */
60
- JPG: 'image/jpeg',
61
-
62
- /**
63
- * MIME Type for PNG images.
64
- * Example: A server serves `.png` files for website logos.
65
- * @type {string}
66
- */
67
- PNG: 'image/png',
68
-
69
- /**
70
- * MIME Type for ICO images.
71
- * Example: A server provides a `.ico` file as the favicon for a website.
72
- * @type {string}
73
- */
74
- ICO: 'image/x-icon',
75
-
76
- /**
77
- * MIME Type for GIF images.
78
- * Example: A messaging app serves `.gif` files for animated stickers.
79
- * @type {string}
80
- */
81
- GIF: 'image/gif',
82
-
83
- /**
84
- * MIME Type for BMP images.
85
- * Example: Specialized imaging software processes `.bmp` files.
86
- * @type {string}
87
- */
88
- BMP: 'image/bmp',
89
-
90
- /**
91
- * MIME Type for TIFF images.
92
- * Example: High-quality scanned documents are stored as `.tiff` files.
93
- * @type {string}
94
- */
95
- TIFF: 'image/tiff',
96
-
97
- /**
98
- * MIME Type for SVG images.
99
- * Example: A website serves `.svg` files for scalable vector icons.
100
- * @type {string}
101
- */
102
- SVG: 'image/svg+xml',
103
-
104
-
105
-
106
- /** Video MIME Types */
107
-
108
- /**
109
- * MIME Type for MP4 videos.
110
- * Example: Video streaming services serve `.mp4` files for playback.
111
- * @type {string}
112
- */
113
- MP4: 'video/mp4',
114
-
115
-
116
-
117
- /** Audio MIME Types */
118
-
119
- /**
120
- * MIME Type for MP3 audio files.
121
- * Example: Music streaming services provide `.mp3` files for playback.
122
- * @type {string}
123
- */
124
- MP3: 'audio/mpeg',
125
-
126
- /**
127
- * MIME Type for WAV audio files.
128
- * Example: A sound editing application processes `.wav` files.
129
- * @type {string}
130
- */
131
- WAV: 'audio/wav',
132
-
133
-
134
-
135
- /** Archive MIME Types */
136
-
137
- /**
138
- * MIME Type for ZIP archives.
139
- * Example: A server offers `.zip` archives for software downloads.
140
- * @type {string}
141
- */
142
- ZIP: 'application/zip',
143
-
144
- /**
145
- * MIME Type for RAR archives.
146
- * Example: Compressed files are provided in `.rar` format for download.
147
- * @type {string}
148
- */
149
- RAR: 'application/vnd.rar',
150
-
151
-
152
-
153
- /** Web-related MIME Types */
154
-
155
- /**
156
- * MIME Type for JSON data.
157
- * Example: REST APIs send data responses as JSON objects.
158
- * @type {string}
159
- */
160
- JSON: 'application/json',
161
-
162
- /**
163
- * MIME Type for XML data.
164
- * Example: SOAP APIs exchange data using `.xml` payloads.
165
- * @type {string}
166
- */
167
- XML: 'application/xml',
168
-
169
- /**
170
- * MIME Type for JavaScript files.
171
- * Example: A server delivers a `.js` file requested by a web browser.
172
- * @type {string}
173
- */
174
- JS: 'application/javascript',
175
-
176
- /**
177
- * MIME Type for CSS files.
178
- * Example: A server serves `.css` files to style a web page.
179
- * @type {string}
180
- */
181
- CSS: 'text/css',
182
-
183
- /**
184
- * MIME Type for HTML files.
185
- * Example: A server sends an `.html` file as a response to a browser request.
186
- * @type {string}
187
- */
188
- HTML: 'text/html',
189
- });
190
-
191
- export default mimeTypesConstants;
1
+ /**
2
+ * @fileoverview Defines the various MIME types used in the application.
3
+ * This module exports an object that contains the different MIME types
4
+ * the application can handle. These MIME types are used to identify the format of data being processed or served.
5
+ *
6
+ * @module constants/mimeTypes
7
+ * @version 1.0.0
8
+ * @license CC BY-NC-ND 4.0
9
+ *
10
+ * @contact Mohammad Montasim -Al- Mamun Shuvo
11
+ * @created 2025-01-28
12
+ * @contactEmail montasimmamun@gmail.com
13
+ * @contactGithub https://github.com/montasim
14
+ */
15
+ /**
16
+ * An object representing different MIME types.
17
+ * @enum {string}
18
+ */
19
+ const mimeTypesLite = Object.freeze({
20
+ /** Document MIME Types */
21
+ /**
22
+ * MIME Type for PDF files.
23
+ * Example: The application generates an invoice as a `.pdf` file for download.
24
+ */
25
+ PDF: 'application/pdf',
26
+ /**
27
+ * MIME Type for Markdown files.
28
+ * Example: Documentation files are stored and processed as `.md`.
29
+ */
30
+ MD: 'text/markdown',
31
+ /**
32
+ * MIME Type for Plain Text files.
33
+ * Example: A log file is served as a `.txt` file.
34
+ */
35
+ TXT: 'text/plain',
36
+ /**
37
+ * MIME Type for CSV files.
38
+ * Example: Exported reports are downloaded as `.csv` files.
39
+ */
40
+ CSV: 'text/csv',
41
+ /** Image MIME Types */
42
+ /**
43
+ * MIME Type for JPEG images.
44
+ * Example: User profile pictures are uploaded and served as `.jpeg` images.
45
+ */
46
+ JPG: 'image/jpeg',
47
+ /**
48
+ * MIME Type for PNG images.
49
+ * Example: A server serves `.png` files for website logos.
50
+ */
51
+ PNG: 'image/png',
52
+ /**
53
+ * MIME Type for ICO images.
54
+ * Example: A server provides a `.ico` file as the favicon for a website.
55
+ */
56
+ ICO: 'image/x-icon',
57
+ /**
58
+ * MIME Type for GIF images.
59
+ * Example: A messaging app serves `.gif` files for animated stickers.
60
+ */
61
+ GIF: 'image/gif',
62
+ /**
63
+ * MIME Type for BMP images.
64
+ * Example: Specialized imaging software processes `.bmp` files.
65
+ */
66
+ BMP: 'image/bmp',
67
+ /**
68
+ * MIME Type for TIFF images.
69
+ * Example: High-quality scanned documents are stored as `.tiff` files.
70
+ */
71
+ TIFF: 'image/tiff',
72
+ /**
73
+ * MIME Type for SVG images.
74
+ * Example: A website serves `.svg` files for scalable vector icons.
75
+ */
76
+ SVG: 'image/svg+xml',
77
+ /** Video MIME Types */
78
+ /**
79
+ * MIME Type for MP4 videos.
80
+ * Example: Video streaming services serve `.mp4` files for playback.
81
+ */
82
+ MP4: 'video/mp4',
83
+ /** Audio MIME Types */
84
+ /**
85
+ * MIME Type for MP3 audio files.
86
+ * Example: Music streaming services provide `.mp3` files for playback.
87
+ */
88
+ MP3: 'audio/mpeg',
89
+ /**
90
+ * MIME Type for WAV audio files.
91
+ * Example: A sound editing application processes `.wav` files.
92
+ */
93
+ WAV: 'audio/wav',
94
+ /** Archive MIME Types */
95
+ /**
96
+ * MIME Type for ZIP archives.
97
+ * Example: A server offers `.zip` archives for software downloads.
98
+ */
99
+ ZIP: 'application/zip',
100
+ /**
101
+ * MIME Type for RAR archives.
102
+ * Example: Compressed files are provided in `.rar` format for download.
103
+ */
104
+ RAR: 'application/vnd.rar',
105
+ /** Web-related MIME Types */
106
+ /**
107
+ * MIME Type for JSON data.
108
+ * Example: REST APIs send data responses as JSON objects.
109
+ */
110
+ JSON: 'application/json',
111
+ /**
112
+ * MIME Type for XML data.
113
+ * Example: SOAP APIs exchange data using `.xml` payloads.
114
+ */
115
+ XML: 'application/xml',
116
+ /**
117
+ * MIME Type for JavaScript files.
118
+ * Example: A server delivers a `.js` file requested by a web browser.
119
+ */
120
+ JS: 'application/javascript',
121
+ /**
122
+ * MIME Type for CSS files.
123
+ * Example: A server serves `.css` files to style a web page.
124
+ */
125
+ CSS: 'text/css',
126
+ /**
127
+ * MIME Type for HTML files.
128
+ * Example: A server sends an `.html` file as a response to a browser request.
129
+ */
130
+ HTML: 'text/html',
131
+ });
132
+ export default mimeTypesLite;
package/package.json CHANGED
@@ -1,24 +1,69 @@
1
- {
2
- "name": "mime-types-lite",
3
- "version": "1.0.0",
4
- "description": "A collection of common MIME types for use in applications.",
5
- "main": "index.js",
6
- "type": "module",
7
- "keywords": ["MIME types", "constants", "MIME", "file types"],
8
- "author": "Mohammad Montasim-Al-Mamun Shuvo",
9
- "license": "CC BY-NC-ND 4.0",
10
- "repository": {
11
- "type": "git",
12
- "url": "git+https://github.com/montasim/mime-types-lite.git"
13
- },
14
- "bugs": {
15
- "url": "https://github.com/montasim/mime-types-lite/issues"
16
- },
17
- "homepage": "https://github.com/montasim/mime-types-lite",
18
- "publishConfig": {
19
- "access": "public"
20
- },
21
- "scripts": {
22
- "test": "echo \"Error: no test specified\" && exit 1"
23
- }
24
- }
1
+ {
2
+ "name": "mime-types-lite",
3
+ "version": "1.0.1",
4
+ "description": "A collection of common MIME types for use in applications.",
5
+ "type": "module",
6
+ "main": "build/index.js",
7
+ "engines": {
8
+ "node": ">=23.x",
9
+ "npm": ">=10.x"
10
+ },
11
+ "keywords": [
12
+ "MIME types",
13
+ "constants",
14
+ "MIME",
15
+ "file types"
16
+ ],
17
+ "author": {
18
+ "name": "Mohammad Montasim -Al- Mamun Shuvo",
19
+ "portfolio": "https://montasim-dev.web.app/",
20
+ "contact": {
21
+ "email": "montasimmamun@gmail.com",
22
+ "mobile": "+8801722815469"
23
+ },
24
+ "social": {
25
+ "linkedIn": "https://www.linkedin.com/in/montasim",
26
+ "gitHub": "https://github.com/montasim"
27
+ }
28
+ },
29
+ "license": "CC BY-NC-ND 4.0",
30
+ "repository": {
31
+ "type": "git",
32
+ "url": "git+https://github.com/montasim/mime-types-lite.git"
33
+ },
34
+ "bugs": {
35
+ "url": "https://github.com/montasim/mime-types-lite/issues"
36
+ },
37
+ "homepage": "https://github.com/montasim/mime-types-lite",
38
+ "publishConfig": {
39
+ "access": "public"
40
+ },
41
+ "files": [
42
+ "build",
43
+ "README.md"
44
+ ],
45
+ "scripts": {
46
+ "build": "eslint . --fix && prettier . --write && tsc",
47
+ "test": "jest",
48
+ "eslint:check": "eslint .",
49
+ "eslint:fix": "eslint . --fix",
50
+ "prettier:check": "prettier . --check",
51
+ "prettier:fix": "prettier . --write",
52
+ "lint:fix": "eslint . --fix && prettier . --write"
53
+ },
54
+ "devDependencies": {
55
+ "@eslint/js": "^9.19.0",
56
+ "@types/jest": "^29.5.14",
57
+ "@typescript-eslint/eslint-plugin": "^8.22.0",
58
+ "@typescript-eslint/parser": "^8.22.0",
59
+ "eslint": "^9.19.0",
60
+ "eslint-plugin-jest": "^28.10.0",
61
+ "eslint-plugin-prettier": "^5.2.1",
62
+ "eslint-plugin-security": "^3.0.1",
63
+ "globals": "^15.14.0",
64
+ "jest": "^29.7.0",
65
+ "prettier": "^3.3.3",
66
+ "ts-jest": "^29.2.5",
67
+ "ts-node": "^10.9.2"
68
+ }
69
+ }