UNPKG

@ofzza/entt

Version:

Modular TypeScript data-modeling solution, implementing nestable serialization/deserialization and flexible validation

github.com/ofzza/enTT

ofzza/enTT

84 lines (46 loc) • 2.23 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# 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](#get-entt) - [Using enTT](#using-entt) - TODO: ... - [Contributing](#contributing) - [Reporting Issues](#reporting-issues) - [Contributing Code](#contributing-code) # Get enTT To start using `enTT` in your project, simply install it from NPM by running the following in your terminal: ```sh $ npm install @ofzza/entt --save ``` Alternatively, get an extended implementation: - RxJS extension: [enTT-RxJS](https://github.com/ofzza/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](https://github.com/ofzza/onboarding/blob/master/CONTRIBUTING/github.md) ## Contributing Code For work-flow and general etiquette when contributing, please see: - [Git Source-Control Work-Flow](https://github.com/ofzza/onboarding/blob/master/CONTRIBUTING/git.md) - [GitHub Work-Flow](https://github.com/ofzza/onboarding/blob/master/CONTRIBUTING/github.md) Please accompany any work, fix or feature with their own issue, in it's own branch (see [Git Source-Control Work-Flow](https://github.com/ofzza/onboarding/blob/master/CONTRIBUTING/git.md) for branch naming conventions), and once done, request merge via pull request. When creating issues and PRs, please keep to provided templates.