@alessiofrittoli/exception 0.1.0

package/README.md

@@ -0,0 +1,132 @@
+# Exception 🚦
+
+Version 0.1.0
+
+## Handle errors with ease
+
+### Table of Contents
+
+- [Getting started](#getting-started)
+- [Development](#development)
+	- [ESLint](#eslint)
+	- [Jest](#jest)
+- [Contributing](#contributing)
+- [Security](#security)
+- [Credits](#made-with-)
+
+---
+
+### Getting started
+
+Run the following command to start using `@alessiofrittoli/exception` in your projects:
+
+```bash
+npm i @alessiofrittoli/exception
+```
+
+or using `pnpm`
+
+```bash
+pnpm i @alessiofrittoli/exception
+```
+
+---
+
+### Development
+
+#### Install depenendencies
+
+```bash
+npm install
+```
+
+or using `pnpm`
+
+```bash
+pnpm i
+```
+
+#### Build your source code
+
+Run the following command to build code for distribution.
+
+```bash
+pnpm build
+```
+
+#### [ESLint](https://www.npmjs.com/package/eslint)
+
+warnings / errors check.
+
+```bash
+pnpm lint
+```
+
+#### [Jest](https://npmjs.com/package/jest)
+
+Run all the defined test suites by running the following:
+
+```bash
+# Run tests and watch file changes.
+pnpm test
+
+# Run tests and watch file changes with jest-environment-jsdom.
+pnpm test:jsdom
+
+# Run tests in a CI environment.
+pnpm test:ci
+
+# Run tests in a CI environment with jest-environment-jsdom.
+pnpm test:ci:jsdom
+```
+
+You can eventually run specific suits like so:
+
+```bash
+pnpm test:jest
+pnpm test:jest:jsdom
+```
+
+---
+
+### Contributing
+
+Contributions are truly welcome!\
+Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
+
+---
+
+### Security
+
+If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.
+
+### Made with ☕
+
+<table style='display:flex;gap:20px;'>
+	<tbody>
+		<tr>
+			<td>
+				<img src='https://avatars.githubusercontent.com/u/35973186' style='width:60px;border-radius:50%;object-fit:contain;'>
+			</td>
+			<td>
+				<table style='display:flex;gap:2px;flex-direction:column;'>
+					<tbody>
+						<tr>
+							<td>
+								<a href='https://github.com/alessiofrittoli' target='_blank' rel='noopener'>Alessio Frittoli</a>
+							</td>
+						</tr>
+						<tr>
+							<td>
+								<small>
+									<a href='https://alessiofrittoli.it' target='_blank' rel='noopener'>https://alessiofrittoli.it</a> |
+									<a href='mailto:info@alessiofrittoli.it' target='_blank' rel='noopener'>info@alessiofrittoli.it</a>
+								</small>
+							</td>
+						</tr>
+					</tbody>
+				</table>
+			</td>
+		</tr>
+	</tbody>
+</table>

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+interface ExceptionOptions<TCode = number> extends ErrorOptions {
+    code: TCode;
+    name?: string;
+    status?: number;
+}
+declare class Exception<TCode = number> extends Error implements ExceptionOptions<TCode> {
+    status: number | undefined;
+    name: string;
+    code: TCode;
+    constructor(message: string, options: ExceptionOptions<TCode>);
+    static isException<TCause = number>(error: any): error is Exception<TCause>;
+}
+
+export { type ExceptionOptions, Exception as default };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+interface ExceptionOptions<TCode = number> extends ErrorOptions {
+    code: TCode;
+    name?: string;
+    status?: number;
+}
+declare class Exception<TCode = number> extends Error implements ExceptionOptions<TCode> {
+    status: number | undefined;
+    name: string;
+    code: TCode;
+    constructor(message: string, options: ExceptionOptions<TCode>);
+    static isException<TCause = number>(error: any): error is Exception<TCause>;
+}
+
+export { type ExceptionOptions, Exception as default };

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';var s=class n extends Error{status;name;code;constructor(e,t){super(e,t),this.name=t.name||"Exception",this.message=e,this.code=t.code,this.status=t.status;}static isException(e){return e instanceof n}},o=s;module.exports=o;

package/dist/index.mjs

@@ -0,0 +1 @@
+var s=class n extends Error{status;name;code;constructor(e,t){super(e,t),this.name=t.name||"Exception",this.message=e,this.code=t.code,this.status=t.status;}static isException(e){return e instanceof n}},i=s;export{i as default};

package/license.md

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

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "@alessiofrittoli/exception",
+	"version": "0.1.0",
+	"description": "Handle errors with ease",
+	"author": {
+		"name": "Alessio Frittoli",
+		"email": "info@alessiofrittoli.it",
+		"url": "https://alessiofrittoli.it"
+	},
+	"license": "MIT",
+	"keywords": [
+		"exceptions",
+		"errors"
+	],
+	"homepage": "https://github.com/alessiofrittoli/exception#readme",
+	"bugs": {
+		"url": "https://github.com/alessiofrittoli/exception/issues",
+		"email": "info@alessiofrittoli.it"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/alessiofrittoli/exception.git"
+	},
+	"main": "./dist/index.js",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"sideEffects": false,
+	"scripts": {
+		"build": "eslint && pnpm test:ci && pnpm test:ci:jsdom && tsup",
+		"lint": "eslint",
+		"test": "jest --watchAll --verbose",
+		"test:jsdom": "JSDOM=true pnpm test",
+		"test:ci": "jest --ci --verbose",
+		"test:ci:jsdom": "JSDOM=true pnpm test:ci",
+		"test:jest": "pnpm test jest.test.ts",
+		"test:jest:jsdom": "JSDOM=true pnpm test:jest"
+	},
+	"devDependencies": {
+		"@eslint/js": "^9.17.0",
+		"@jest/globals": "^29.7.0",
+		"@types/jest": "^29.5.14",
+		"@types/node": "^22.10.2",
+		"dotenv": "^16.4.7",
+		"eslint": "^9.17.0",
+		"globals": "^15.13.0",
+		"jest": "^29.7.0",
+		"jest-environment-jsdom": "^29.7.0",
+		"ts-jest": "^29.2.5",
+		"ts-node": "^10.9.2",
+		"tsup": "^8.3.5",
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.18.0"
+	}
+}