@ofzza/entt

enTT

enTT, read as "Entity", is an extensible TypeScript data-modeling solution with some of the typically required functionality, such as change-detection, easy import/export, composition/decomposition, data validation, etc., all available out of the box and easy to use.

Table of contents:

• Get enTT
• Using enTT
  • TODO: ...
• Contributing
  • Reporting Issues
  • Contributing Code

Get enTT

To start using enTT in your project, simply install it from NPM by running the following in your terminal:

$ npm install @ofzza/entt --save

Alternatively, get an extended implementation:

• RxJS extension: enTT-RxJS

Using enTT

Using decorators and corresponding services

TODO: Static decorators ...

TODO: Property decorator A

TODO: Propperty decorator B

TODO: Class decorator C

EnTT-ifying your classes

TODO: ...

Using dynamic decorators and corresponding services

TODO: ... note about checking if decorated class was enTT-ified

TODO: Dynamic decrators ...

TODO: Property decorator D

TODO: Property decorator E

TODO: Class decorator F

Customizing enTT

Custom decorators and services

Custom class decorators

TODO: ...

Custom property decorators

TODO: ...

Contributing

Reporting Issues

When reporting issues, please keep to provided templates.

Before reporting issues, please read: GitHub Work-Flow

Contributing Code

For work-flow and general etiquette when contributing, please see:

• Git Source-Control Work-Flow
• GitHub Work-Flow

Please accompany any work, fix or feature with their own issue, in it's own branch (see Git Source-Control Work-Flow for branch naming conventions), and once done, request merge via pull request.

When creating issues and PRs, please keep to provided templates.