@amndns/service-utils

> @amndns/service-utils is a collection of common utilities and tools used by my TypeScript backend services.

✨ Features

Environment Utilities
- function getOsEnv
- function getOsEnvOptional
- function getOsEnvArray
- function getPath
- function getPaths
- function getOsPath
- function getOsPaths

Logger Utilities
- class WinstonLogger
- decorator Logger
- interface LoggerInterface

TS Utilities
- function isDefined
- function toNumber
- function toBool
- function toArray

$3

- [ ] Add unit tests for the environment and logger utilities.

🚀 Get Started

This project was created using TypeScript.

Below is a guide on the common commands you might use all throughout the development process. In the project directory, you can run:

#### yarn install

Installs all package dependencies of the app. Make sure you have yarn installed and configured first.

#### yarn build-ts

Transpiles all of the .ts files from the src/ directory into .js CommonJS files. This also "franks" the dist folder by copying the package.json, README.md, and LICENSE files into it. The target directory is in the dist/ folder.

> _NOTE:_ When publishing this module, make sure you publish the "franked" dist/ directory instead of the root directory. This is so projects can cleanly import from the subfolders of this module.

#### yarn lint

Launches the linter against all of the .ts files from the src/ and test/ directory. The project specifically uses ESLint and Prettier as the linter and code formatter, respectively.

#### yarn test:unit

Launches the test runner in interactive watch mode using Jest. The test is launched against all of the .ts files from the test/ directory.

*
_This README was generated with ❤️ by readme-md-generator_