This package implements a number of common Boring Utilities
.
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 10.0 or higher is required.
Installation is done using the
yarn add
command:
$ yarn add @boringcodes/utils
The following modules are included:
- Node env detector
- Custom logger
- Custom errors classes
- Error handler
- Express middleware
Then run the build command
yarn build
.
βββ .github/workflows
βΒ Β βββ create-github-release.yml
βΒ Β βββ main.yml
βΒ Β βββ publish-npm.yml
βββ dist (generated after building)
βββ src
βΒ Β βββ errorHandler.ts
βΒ Β βββ error.ts
βΒ Β βββ express.ts
βΒ Β βββ index.ts
βΒ Β βββ logger.ts
βββ .gitignore
βββ .hustkyrc
βββ .prettierrc.js
βββ CHANGELOG.md
βββ LICENSE
βββ package.json
βββ README.md
βββ rollup.config.js
βββ tsconfig.json
βββ tslint.json
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.