Skip to content
This repository was archived by the owner on Jan 18, 2025. It is now read-only.

Commit 540d07e

Browse files
mrcaidevmrcaidev
committed
feat: v1.0.0
0 parents  commit 540d07e

File tree

94 files changed

+3650
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+3650
-0
lines changed

‎.editorconfig

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true

‎.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist

‎.eslintrc.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"extends": [
3+
"eslint:recommended",
4+
"plugin:@typescript-eslint/strict-type-checked",
5+
"plugin:@typescript-eslint/stylistic-type-checked",
6+
"prettier"
7+
],
8+
"env": {
9+
"browser": true,
10+
"node": true,
11+
"es2023": true
12+
},
13+
"parserOptions": {
14+
"ecmaVersion": "latest",
15+
"sourceType": "module",
16+
"project": true,
17+
"tsconfigRootDir": "."
18+
}
19+
}

‎.gitignore

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

‎.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
pnpm-lock.yaml

‎.prettierrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Yuwang Cai
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# @mrcaidev/http-errors
2+
3+
Utility classes for HTTP errors.
4+
5+
## 📦 Installation
6+
7+
```sh
8+
npm i @mrcaidev/http-errors
9+
```
10+
11+
## 🛠️ Usage
12+
13+
Standard:
14+
15+
```ts
16+
import { BadRequestError } from "@mrcaidev/http-errors";
17+
18+
throw new BadRequestError("Invalid data format");
19+
```
20+
21+
Customization:
22+
23+
```ts
24+
import { HttpError } from "@mrcaidev/http-errors";
25+
26+
throw new HttpError(400, "Invalid data format");
27+
```
28+
29+
Hover over the error class to see its definition and the link to its RFC.
30+
31+
![Hover information](assets/hover-info.jpg)
32+
33+
## 🔎 References
34+
35+
- [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110)
36+
- [RFC 8470](https://www.rfc-editor.org/rfc/rfc8470)
37+
- [RFC 7725](https://www.rfc-editor.org/rfc/rfc7725)
38+
- [RFC 6585](https://www.rfc-editor.org/rfc/rfc6585)
39+
- [RFC 5842](https://www.rfc-editor.org/rfc/rfc5842)
40+
- [RFC 4918](https://www.rfc-editor.org/rfc/rfc4918)
41+
- [RFC 2774](https://www.rfc-editor.org/rfc/rfc2774)
42+
- [RFC 2295](https://www.rfc-editor.org/rfc/rfc2295)
43+
44+
## 📜 License
45+
46+
[MIT](LICENSE)

‎assets/hover-info.jpg

44.3 KB
Loading

‎package.json

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"name": "@mrcaidev/http-errors",
3+
"version": "1.0.0",
4+
"description": "Utility classes for HTTP errors",
5+
"keywords": [
6+
"http",
7+
"error",
8+
"utility",
9+
"typescript"
10+
],
11+
"homepage": "https://github.com/mrcaidev/http-errors",
12+
"bugs": {
13+
"url": "https://github.com/mrcaidev/http-errors/issues",
14+
"email": "[email protected]"
15+
},
16+
"license": "MIT",
17+
"author": {
18+
"name": "Yuwang Cai",
19+
"email": "[email protected]",
20+
"url": "https://mrcai.dev"
21+
},
22+
"repository": {
23+
"url": "https://github.com/mrcaidev/http-errors.git",
24+
"type": "git"
25+
},
26+
"type": "module",
27+
"files": [
28+
"dist"
29+
],
30+
"main": "dist/index.umd.cjs",
31+
"module": "dist/index.js",
32+
"types": "dist/index.d.ts",
33+
"exports": {
34+
".": {
35+
"import": "./dist/index.js",
36+
"require": "./dist/index.umd.cjs"
37+
}
38+
},
39+
"scripts": {
40+
"build": "vite build"
41+
},
42+
"devDependencies": {
43+
"@typescript-eslint/eslint-plugin": "^6.3.0",
44+
"@typescript-eslint/parser": "^6.3.0",
45+
"eslint": "^8.46.0",
46+
"eslint-config-prettier": "^9.0.0",
47+
"prettier": "^3.0.1",
48+
"typescript": "^5.1.6",
49+
"vite": "^4.4.9",
50+
"vite-plugin-dts": "^3.5.1",
51+
"vitest": "^0.34.1"
52+
},
53+
"publishConfig": {
54+
"registry": "https://registry.npmjs.org/",
55+
"access": "public",
56+
"tag": "latest"
57+
}
58+
}

0 commit comments

Comments
 (0)