push.rocks/smartdata
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

imrpove README

Browse Source
This commit is contained in:
Philipp Kunz 2016-09-13 10:17:34 +02:00
parent acf3c29939
commit 7f77634ea1
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,5 +1,7 @@
# smartdata # smartdata
> Note: Still in Beta
smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data. smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data.
It uses MongoDB as persistent storage. It uses MongoDB as persistent storage.
@ -62,7 +64,13 @@ This is done for you!!!
represents a individual document in a collection represents a individual document in a collection
and thereby is ideally suited to extend the class you want to actually store. and thereby is ideally suited to extend the class you want to actually store.
DbDoc extends your class with .save() and saveDeep() methods. DbDoc extends your class with the following methods:
* `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
* `.saveDeep()` does the same like `.save()`.
In addition it will look for properties that reference an object
that extends DbDoc as well and call .saveDeep() on them as well.
Loops are prevented
So now we can get store instances of classes to Db... So now we can get store instances of classes to Db...
How do we get a new class instances from a Doc in DB? How do we get a new class instances from a Doc in DB?