\n\n[](https://codecov.io/gh/ODGodinho/ODGException)\n[](https://github.com/ODGodinho/ODGException/stargazers)\n[](https://www.linkedin.com/in/victor-alves-odgodinho/)\n[](https://github.com/ODGodinho/ODGException/network/members)\n\n[](https://github.com/ODGodinho/ODGException/commits/master)\n[](https://opensource.org/licenses/MIT)\n[](https://github.styleci.io/repos/577124284?branch=main)\n[](https://app.fossa.com/projects/git%2Bgithub.com%2FODGodinho%2FODGException?ref=badge_shield)\n\n
\n\n# Table of Contents\n\n- [๐ Benefits](#-benefits)\n- [๐ Libraries](#-libraries)\n- [๐ Dependencies](#-dependencies)\n- [โฉ Get Started](#-get-started)\n - [๐ Installation](#-installation)\n - [๐ป Prepare to develop](#-prepare-to-develop)\n - [๐ Start Project](#-start-project)\n - [๐จ Build and Run](#-build-and-run)\n - [๐งช Teste Code](#-teste-code)\n\n---\n\n## ๐ Benefits\n\n- ๐ Instance Error with previews error\n- ๐ Code quality guaranteed\n\n## ๐ Libraries\n\n- [Node.js 16](https://nodejs.org/?n=dragonsgamers)\n- [Typescript](https://www.typescriptlang.org/?n=dragonsgamers)\n- [Eslint](https://eslint.org/?n=dragonsgamers)\n- [ODG-Linter-JS](https://github.com/ODGodinho/ODG-Linter-Js?n=dragonsgamers)\n- [EditorConfig](https://editorconfig.org/?n=dragonsgamers)\n- [ReviewDog](https://github.com/reviewdog/action-eslint)\n\n## ๐ Dependencies\n\n- [Node.js](https://nodejs.org) 16 or later\n- [Yarn](https://yarnpkg.com/) Optional/Recommended\n- [ODG TsConfig](https://github.com/ODGodinho/tsconfig) Last Version\n\n## โฉ Get Started\n\n---\n\n### ๐ Installation\n\nRun commands:\n\n```powershell\nyarn add @odg/exception\n```\n\n### ๐ป Prepare To Develop\n\nCreate custom exception\n\n```typescript\nimport { Exception } from \"@odg/exception\";\n\nclass MyException extends Exception {\n\n}\n```\n\nInstance Exception\n\n```typescript\ntry {\n // code\n} catch (error) {\n throw new MyException(\"message\", error, \"EXCEPTION_CODE\");\n}\n```\n\nmake Exception\n\n```typescript\ntry {\n // code\n} catch (error) {\n throw Exception.parse({\n anythingStatus: \"FAILED\",\n anything2: \"anything\"\n });\n}\n```\n\nProps\n\n```typescript\ninterface Exception {\n message: string; // Message of exception\n code?: string | number; // Code of exception\n stack: string; // Stack of Exception\n original?: unknown // Original Preview Exception (Error, Exception, string, unknown)\n getPrevious(): Exception | undefined; // Preview exception parsed to UnknownException class\n}\n```\n\n### ๐ Start Project\n\nFirst install dependencies with the following command\n\n```bash\nbun install\n# or\nnpm install\n```\n\n## ๐จ Build and Run\n\nTo build the project, you can use the following command\n\n> if you change files, you need to run `bun run build` and `bun run test` again\n\n```bash\nbun run build && bun run test\n```\n\n## ๐งช Teste Code\n\nTo Test execute this command\n\n```bash\nbun run test\n# or\nbun run test:watch\n```\n\n## License\n[](https://app.fossa.com/projects/git%2Bgithub.com%2FODGodinho%2FODGException?ref=badge_large)\n","readmeFilename":"README.md"}