This package provides a simple client-side user store.
// module onevar store = ;var user = token: 'raw token';store;
// module twovar store = ;store; // get the current userstore;
This package is intended for use with a CommonJS module bundler. Add it as a dependency to your project with
npm install @planet/user-store --save
The package exports an event emitter with
set() methods. See details below.
Returns any currently stored user (or
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
Unregister a listener for the
© 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.