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

docs(README): update

Browse Source
This commit is contained in:
Philipp Kunz 2018-01-14 17:57:57 +01:00
parent 7e341f2b50
commit aca9817c56
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -47,7 +47,7 @@ How RethinkDB's terms map to the ones of smartdata:
represents a Database. Naturally it has .connect() etc. methods on it. represents a Database. Naturally it has .connect() etc. methods on it.
```javascript ```typescript
import * as smartdata from "smartdata"; import * as smartdata from "smartdata";
let myRethinkDb1 = new smartdata.Db({ let myRethinkDb1 = new smartdata.Db({
@ -64,19 +64,18 @@ A collection is defined by the object class (that is extending smartdata.dbdoc)
So to get to get access to a specific collection you document So to get to get access to a specific collection you document
```javascript ```typescript
// continues from the block before... // continues from the block before...
@Collection(myRethinkDb1) @smartdata.Table(myRethinkDb1)
class MyObject extends smartdata.DbDoc<myObject> { class MyObject extends smartdata.DbDoc<myObject> {
// read the next block about DbDoc // read the next block about DbDoc
@smartdata.svDb() property1: string; // @smartdata.svDb() marks the property for db save @smartdata.svDb() property1: string; // @smartdata.svDb() marks the property for db save
property2: number; // this one is not marked, so it won't be save upon calling this.save() property2: number; // this one is not marked, so it won't be save upon calling this.save()
constructor(optionsArg: { property1: string, property2: number }) { constructor(optionsArg: { property1: string; property2: number }) {
super(); super();
} }
} }
let myCollection = myRethinkDb1.getCollectionByName < myObject > myObject;
// start to instantiate instances of classes from scratch or database // start to instantiate instances of classes from scratch or database
@ -85,10 +84,13 @@ let localObject = new MyObject({
property2: 2 property2: 2
}); });
localObject.save(); // saves the object to the database localObject.save(); // saves the object to the database
```
> Alert: You NEVER instantiate a collection. // start retrieving instances
> This is done for you!!!
MyObject.getInstance<MyObject>({
property: "hi"
}); // outputs a new instance of MyObject with the values from db assigned
```
### class DbDoc ### class DbDoc