egoose

Helper classes and functions for Node.js 12+ written in TypeScript.

Install

Execute the following command from your project folder, where your package.json file is stored:

npm install --save @egodigital/egoose

Documentation

API documentation can be found here.

Samples

egoose-samples contains a repository of samples, which demonstrate, how to use the functions and classes of that module.

Build

Module

First install all required node_modules by executing

npm install

from module's folder.

Now, run TypeScript compiler by executing

npm run build

from same folder.

Publish

FIRST BUILD THE MODULE BEFORE PUBLISH!

npm run build && npm publish

Documentation

Execute

npm run doc

from module's root.

Tests

Run the following command

npm test

from module's folder.