-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
kanekotic
committed
Jan 9, 2019
1 parent
60aaa66
commit cbca321
Showing
1 changed file
with
89 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,89 @@ | ||
| # tarant-sync-server-express | ||
| remote-sync server for bindings for tarant and express | ||
| #  | ||
|
|
||
|
|
||
| [](https://www.npmjs.com/package/tarant-sync-router-express) | ||
| [](https://travis-ci.org/tarantx/tarant-sync-router-express) | ||
| [](https://coveralls.io/github/tarantx/tarant-sync-router-express?branch=master) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Motivation | ||
|
|
||
| remote-sync server for bindings clients using routers or `tarant-sync-router-express` | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| add it to your project using `npm install tarant-sync-router-express --save` or `yarn add tarant-sync-router-express` | ||
|
|
||
| ## Usage | ||
|
|
||
| initialize your controllers/routers by calling the `SyncController` with the actor system and the wanted configuration. Adding them to your express app. | ||
|
|
||
| ```js | ||
| import SyncController from "tarant-sync-router-express" | ||
| import { ActorSystem, ActorSystemConfigurationBuilder } from 'tarant' | ||
| import AppActor from '../AppActor' | ||
|
|
||
| const app: express.Application = express() | ||
| const port: number = 3002 | ||
| const config : any = { | ||
| paths: { | ||
| pull: "/pull", | ||
| push: "/push", | ||
| }, | ||
| actorTypes: { AppActor } | ||
| } | ||
|
|
||
| const system : any = ActorSystem.for(ActorSystemConfigurationBuilder.define().done()) | ||
|
|
||
| app.use(SyncController(system, config)) | ||
|
|
||
| app.listen(port, () => { | ||
| console.log(`Listening at http://localhost:${port}/`) | ||
| }) | ||
| ``` | ||
|
|
||
| your actors will require to implement IUpdatable (UpdateFrom) and IExportable (toJson) | ||
|
|
||
| ```js | ||
| import { Actor } from "tarant"; | ||
| import { IUpdatable, IExportable } from "tarant-sync-router-express" | ||
|
|
||
| export default class AppActor extends Actor implements IUpdatable, IExportable { | ||
|
|
||
| constructor(name: string) { | ||
| super(name) | ||
| } | ||
|
|
||
| addOne() { | ||
| this.counter++ | ||
| } | ||
|
|
||
| toJson(){ | ||
| return { | ||
| id: this.id, | ||
| type:"AppActor", | ||
| counter: this.counter | ||
| } | ||
| } | ||
|
|
||
| updateFrom({ counter }: any): void { | ||
| this.counter = counter | ||
| } | ||
|
|
||
| private counter = 1; | ||
| } | ||
|
|
||
| ``` | ||
| ## confiuration options | ||
|
|
||
| 3. paths.pull: path to endpoint for pulling data from the backend | ||
| 3. paths.push: path to endpoint for pushing data to the backend | ||
| 4. ActorTypes: objects registering the type of actors that should be sync with the backend | ||
|
|
||
| ##### Created my free [logo](https://logomakr.com/0ZeODI) at <a href="http://logomakr.com" title="Logo Makr">LogoMakr.com</a> |