@golemio/utils v1.0.0

Golemio Utils Library

Library of Utils classes of the Golemio Data Platform System.

Developed by http://operatorict.cz

Prerequisites

• node.js (https://nodejs.org)
• yarn (https://yarnpkg.com)
• TypeScript (https://www.typescriptlang.org/)

Installation

Install Node

Install all npm modules using command:

yarn

Compilation of typescript code

To compile typescript code into js one-time

yarn run build

or run this, to watch all changes

yarn run build-watch

from the application's root directory.

Usage

In your project's package.json set dependency to Utils

npm install @golemio/utils --save

or

yarn add @golemio/utils --save

Then import module, e.g.

import * as ObjectUtils from "@golemio/utils";

Logging

Logging uses Winston for standard logging with levels and debug (https://www.npmjs.com/package/debug) for debugging.

All logs with silly and debug level are printed as standard log (if appropriate log level is set) using Winston as well as using debug module with "golemio:utils" settings.

You can set both LOG_LEVEL and DEBUG settings in ENV variables.

Documentation

For generating documentation run yarn run generate-docs. TypeDoc source code documentation is located in docs/typedoc.

Contribution guidelines

Please read CONTRIBUTING.md.

Troubleshooting

Contact benak@operatorict.cz or vycpalek@operatorict.cz