@awesome-nodes/object
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Welcome to Awesome Nodes Object Type Helper Library 👋

Version Documentation Code Style: 4-space K&R. License: MIT

🔎 Basic class objects and extended functionality with patterns and best practices from about two decades of source code development.
Provides basic object behavior and type helper utilities for modern object oriented programming.

🏠 Homepage

Demo

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Download

git clone git+ssh://git@gitlab.com/awesome-nodes/object.git

Install

cd object
npm install

Usage

npm run start

Run Unit Tests

Single Run:

npm run test

Run in watch mode:

npm run test:w

Run TypeScript Check

Single Run:

npm run tscheck

Run in watch mode:

npm run tscheck:w

Run Circular Dependency Check

npm run tscheck:circular

Run Coding Style Tests

npm run eslint

Run Build

The build output contains three kinds of library variants:

  • ES5 for NodeJS applications
  • ES6 for tree shaking builds
  • and a UMD bundle for web applications
npm run build

Deployment

Deployment is done by publishing the npm package using:

npm publish

Built With

  • BuildSystem - Integrated Zero Configuration Build System for Awesome Nodes Apps and Framework Components

👤 Authors

See also the list of contributors who participated in this project.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check our issues page.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Please read the DEVELOPING.md for details on how to develop this repository.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Show your support

Give a ⭐️ if this project helped you!

License

MIT


This README was generated initially with ❤️ by readme-md-generator

Package Sidebar

Install

npm i @awesome-nodes/object

Weekly Downloads

5

Version

1.0.0

License

MIT

Unpacked Size

682 kB

Total Files

197

Last publish

Collaborators

  • christian.kusmanow
  • markusfaatz