hoodiehq / hoodie-account-client / 445

100%

master: 99%

Pull #129

travis-ci

feat: `options.store` and `account.ready`

BREAKING CHANGE:

As part of our effort to make Hoodie Client compatible with Service Worker and other environments that do not have access to localStorage, we have to make the Account Client compatible with async store APIs. That means we can’t load the current account state synchronously, so this is no longer be possible:

```js
var account = new Account({
  url: /api
})
if (account.isSignedIn()) {
  sayHi(account.username)
}
```

Starting with this release, you have to wrap the synchronous methods and properties into `account.ready.then()`

```js
account.ready.then(function () {
  if (account.isSignedIn()) {
    sayHi(account.username)
  }
})
```

By default, the account will still use localStorage (via [humble-localstorage](https://github.com/gr2m/humble-localstorage)) to persist its state, but it will now be made asynchronous. In order to use another storage a new `options.store` argument can be passed to the Account constructor:

```js
var account = new Account({
  url: /api,
  store: {
    set: writeAccountState
    get: getAccountState,
    unset: clearAccountState,
  }
})
```

All three `options.store` methods must return promises. `store.get` must resolve with the persisted account properties or an empty object.

116 of 116 new or added lines in 24 files covered. (100.0%)

507 of 507 relevant lines covered (100.0%)

7.47 hits per line