Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egodigital/egoose
Helper classes and functions for Node.js 10+ written in TypeScript.
https://github.com/egodigital/egoose
azure azure-storage classes events filesystem functions geolocation helpers http-client logging mongodb node-module rest-api streams typescript
Last synced: about 2 months ago
JSON representation
Helper classes and functions for Node.js 10+ written in TypeScript.
- Host: GitHub
- URL: https://github.com/egodigital/egoose
- Owner: egodigital
- License: lgpl-3.0
- Archived: true
- Created: 2018-07-19T13:13:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-06T14:47:32.000Z (over 4 years ago)
- Last Synced: 2024-09-21T18:17:19.692Z (about 2 months ago)
- Topics: azure, azure-storage, classes, events, filesystem, functions, geolocation, helpers, http-client, logging, mongodb, node-module, rest-api, streams, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@egodigital/egoose
- Size: 757 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@egodigital/egoose)
# egoose
Helper classes and functions for [Node.js 12+](https://nodejs.org/dist/latest-v12.x/docs/api/) written in [TypeScript](https://www.typescriptlang.org/).
## Install
Execute the following command from your project folder, where your `package.json` file is stored:
```bash
npm install --save @egodigital/egoose
```
## Documentation
API documentation can be found [here](https://egodigital.github.io/egoose/).
## Samples
[egoose-samples](https://github.com/egodigital/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
```bash
npm install
```
from module's folder.
Now, run [TypeScript compiler](https://www.npmjs.com/package/typescript) by executing
```bash
npm run build
```
from same folder.
### Publish
FIRST [BUILD](#build) THE MODULE BEFORE PUBLISH!
```bash
npm run build && npm publish
```
### Documentation
Execute
```bash
npm run doc
```
from module's root.
## Tests
Run the following command
```bash
npm test
```
from module's folder.