Skip to content

Latest commit

 

History

History
112 lines (89 loc) · 3.4 KB

README.md

File metadata and controls

112 lines (89 loc) · 3.4 KB

utils

Boring Utilities

About

This package implements a number of common Boring Utilities.

Installation

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

Features

The following modules are included:

  • Node env detector
  • Custom logger
  • Custom errors classes
  • Error handler
  • Express middleware

Usage

Then run the build command

yarn build

Directories

.
├── .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

Contributing

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.

Authors

BoringCodes

License

MIT