Comparing version 1.1.8 to 1.2.0
@@ -7,3 +7,3 @@ 'use strict'; | ||
var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol ? "symbol" : typeof obj; }; | ||
var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; | ||
@@ -10,0 +10,0 @@ exports.default = localsync; |
{ | ||
"name": "localsync", | ||
"version": "1.1.8", | ||
"version": "1.2.0", | ||
"description": "a lightweight module to sync JS objects in realtime across tabs / windows of a browser.", | ||
@@ -51,7 +51,7 @@ "main": "lib/index.js", | ||
"chai": "^3.0.0", | ||
"cookiesync": "^1.1.8", | ||
"serversync": "^1.1.8", | ||
"socketsync": "^1.1.8", | ||
"storagesync": "^1.1.8", | ||
"webrtcsync": "^1.1.8" | ||
"cookiesync": "^1.2.0", | ||
"serversync": "^1.2.0", | ||
"socketsync": "^1.2.0", | ||
"storagesync": "^1.2.0", | ||
"webrtcsync": "^1.2.0" | ||
}, | ||
@@ -58,0 +58,0 @@ "devDependencies": { |
@@ -46,4 +46,9 @@ [](https://npmjs.com/packages/localsync) | ||
/** Start synchronizing. */ | ||
usersync.start() | ||
/** | ||
* Start synchronizing. | ||
* Passing true tells localsync to poll the current storage mechanism once on | ||
* start for any pre-existing state that may be there (cross session). | ||
* Defaults to false - may change to true in a future major version. | ||
*/ | ||
usersync.start(true) | ||
@@ -136,3 +141,3 @@ /** IE / Edge do not support local storage across multiple tabs. localsync will automatically fallback to a cookie polling mechanism here. You don't need to do anything else. */ | ||
-------- | -------- | ----------- | --------------- | ||
`start` | `function` | `N/A` | Call to start syncing | ||
`start` | `function` | `N/A` | Call to start syncing. Accepts one boolean parameter (default false). If passed true, will run the synchronization on start. | ||
`stop` | `function` | `N/A` | Call to stop syncing | ||
@@ -145,1 +150,26 @@ `trigger` | `function` | `N/A` | Call to trigger a sync to occur to all other clients | ||
___ | ||
## Contributing | ||
To setup localsync for use in development run the following steps at CLI: | ||
```bash | ||
npm i -g lerna@latest | ||
git clone https://github.com/noderaider/localsync | ||
cd localsync | ||
lerna bootstrap | ||
lerna run start | ||
``` | ||
Then from your project: | ||
```bash | ||
npm link ../localsync/packages/localsync | ||
# start your project, localsync should hot reload as you update its source code. | ||
``` | ||
___ | ||
<sup>Feature requests and pull requests encouraged!</sup> |
16667
173
Updatedcookiesync@^1.2.0
Updatedserversync@^1.2.0
Updatedsocketsync@^1.2.0
Updatedstoragesync@^1.2.0
Updatedwebrtcsync@^1.2.0