@planet/user-store

User Store

This package provides a simple client-side user store.

Example

// module one
var store = require('@planet/user-store');
var user = {token: 'raw token'};

store.set(user);

// module two
var store = require('@planet/user-store');

store.get(); // get the current user

store.on('update', function(user) {
  // handle any new user
});

Installation

This package is intended for use with a CommonJS module bundler. Add it as a dependency to your project with npm:

npm install @planet/user-store --save

API

The package exports an event emitter with get() and set() methods. See details below.

store.get()

Returns any currently stored user (or null).

store.set(user)

Store a user in localStorage (with fallbacks to sessionStorage, cookie, and memory). The user must be serializable as JSON. Calls to set() trigger an update event. Call with null to clear the stored user. Note that as of version 2, the user object can only contain a string token property. This may change in future major versions.

store.on('update', callback [, thisObj])

Listen for the 'update' event. The callback will be called with the user object whenever one is set (and will be called with null when the store is cleared).

store.once('update', callback [, thisObj])

Listen for a single update event.

store.off('update', callback)

Unregister a listener for the update event.

License

© Planet Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.