diff --git a/README.md b/README.md index 49837b0..9e02ba2 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ npm install linq-fns --save ``` -> This version is an alpha release so if you have any problems, please don't hesitate to let me know. 👋 - Browser client files can be found in the [release](https://github.com/jinhduong/linq-fns/tree/master/release) folder. ### Basic example @@ -19,7 +17,6 @@ Browser client files can be found in the [release](https://github.com/jinhduong/ ```ts // ES6 import { Queryable } from 'linq-fns'; - // ES5 const Queryable = require('linq-fns').Queryable; @@ -30,10 +27,17 @@ let query = Queryable .select(x => { return { area: x.key, - total: Queryable.fromSync(x.items).count() // This will return a number, not Promise + total: Queryable.fromSync(x.items).count() + // This will return a number, not Promise } }) -const asyncData = query.toList() // Will return Promise<{area:string, total:number}> + +// Async/ await +const data = await query.toList(); + +// Promise +// Will return Promise<{area:string, total:number}> +const asyncData = query.toList(); asyncData.then(data => { console.log(data); // [ @@ -55,23 +59,29 @@ admin.initializeApp({ }); const db = admin.database(); -const postsQuery = new FireBaseQueryable(db,'.posts'); +const postsRepo = new FireBaseQueryable(db,'.posts'); // READ AND QUERY DATA // ES5 Promise -postsQuery.getQuery().where('...').select('...').toList().then(x=>'...'); +postsRepo.getQuery() + .where('...') + .select('...') + .toList().then(x=>'...'); // Async/await -const data = await postsQuery.getQuery().where('...').select('...').toList(); +const data = await postsRepo.getQuery() + .where('...') + .select('...') + .toList(); // WRITE DATA // Prepare calls, but do not send requests to server -postsQuery.add(item); -postsQuery.remove(item); -postsQuery.update(item); +postsRepo.add(item); +postsRepo.remove(item); +postsRepo.update(item); // Call this to execute 3 above methods -postsQuery.commitChanges(); +postsRepo.commitChanges(); ``` @@ -80,15 +90,14 @@ postsQuery.commitChanges(); // Node const LocalStorageQueryable = require('linq-fns').LocalStorageQueryable; +const postsRepo = new LocalStorageQueryable("posts"); -const postsQuery = new LocalStorageQueryable("posts"); - -postsQuery.add(item); -postsQuery.remove(item); -postsQuery.update(item); +postsRepo.add(item); +postsRepo.remove(item); +postsRepo.update(item); // Call this to execute 3 above methods -postsQuery.commitChanges(); +postsRepo.commitChanges(); ``` #### gist file @@ -96,17 +105,15 @@ postsQuery.commitChanges(); //Node const GistQueryable = require('linq-fns').GistQueryable; - -const postsQuery = new GistQueryable( +const postsRepo = new GistQueryable( "6d183b7f997819cd5a8354f35c1e471f123", // gist file "259f97b96762c9d3a155630d12321fd1cfaf253ff", // access token "posts") // table name -postsQuery.add(item); -postsQuery.remove(item); -postsQuery.update(item); -postsQuery.commitChanges(); - +postsRepo.add(item); +postsRepo.remove(item); +postsRepo.update(item); +postsRepo.commitChanges(); ``` ### Process @@ -155,6 +162,9 @@ postsQuery.commitChanges(); - [x] Gists Github : `Node` & `Browser` - [ ] ... +### Documents +https://github.com/jinhduong/linq-fns/tree/docs + ### License [MIT License](http://opensource.org/licenses/MIT) diff --git a/src/drivers/index.ts b/src/drivers/index.ts index d48209a..9fcbe51 100644 --- a/src/drivers/index.ts +++ b/src/drivers/index.ts @@ -1,3 +1,3 @@ export * from './linq-fns.firebase'; -export * from './linq-fns.gits'; -export * from './linq-fns.localStogare'; \ No newline at end of file +export * from './linq-fns.gist'; +export * from './linq-fns.localStorage'; diff --git a/src/drivers/linq-fns.gits.ts b/src/drivers/linq-fns.gist.ts similarity index 100% rename from src/drivers/linq-fns.gits.ts rename to src/drivers/linq-fns.gist.ts diff --git a/src/drivers/linq-fns.localStogare.ts b/src/drivers/linq-fns.localStorage.ts similarity index 100% rename from src/drivers/linq-fns.localStogare.ts rename to src/drivers/linq-fns.localStorage.ts