npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mobx-session

v1.0.0

Published

Save your session with MobX, using IndexedDB, WebSQL, or localStorage

Downloads

15

Readme

Build Status Maintainability Test Coverage

Mobx Session

Mobx Session helps you manage your session data providing an API to save and access your info whenever and wherever you want.

The stored data will be saved with localforage.

Installation

yarn:

yarn add mobx-session

npm:

npm install mobx-session

Usage

It's really straight forward to use.

First you must initialize the Storage. For that, you should call

import SessionStore from 'mobx-session';

SessionStore.initialize();

This should be called before any other method call, so I would recommend putting it on the index.js or App of your site, or in the top of another Store that uses SessionStore (like in this example).

There are several config options to customize this method, go to the API doc to see more.

For example

import SessionStore from 'mobx-session';

SessionStore.initialize({ name: 'my-app-name' });

Then, you can use it wherever you want.

Inside a Component

import SessionStore from 'mobx-session';

const MyComponent = observer(() => {
  if (SessionStore.initialized) {
    return (
      <div>
        {
          SessionStore.hasSession
          ? <p>Hello!</p>
          : <p>Login</p>
        }
      </div>
    );
  }

  return null;
})

You can use the decorator syntax

import SessionStore from 'mobx-session';

@observer
const MyComponent = () => {
  if (SessionStore.initialized) {
    return (
      <div>
        {
          SessionStore.hasSession
          ? <p>Hello!</p>
          : <p>Login</p>
        }
      </div>
    );
  }

  return null;
}

TIP: don't forget to make your component an observer so you don't lose the reference.

Inside a Store

import SessionStore from 'mobx-session';

class UserStore {
  constructor() {
    extendObservable(this, {
      user: null,
      get loggedIn() {
        return this.user !== null && SessionStore.hasSession;
      },
    });
  }
  ......
}

You can also use the decorator syntax

import SessionStore from 'mobx-session';

class UserStore {
    @observable user = null;
    @computed get loggedIn() {
        return this.user !== null && SessionStore.hasSession;
    }
    ......
}

TIP: inside a store, don't forget to use it inside a computed value or an auto-run so you don't loose the reference.

Examples

API

initialize(config: object): Promise

Initialize an instance of the storage inside the session.

Options can be the ones listed in the localforage library

saveSession(session: object): Promise

Saves the session object in the store and storage

deleteSession(): Promise

Deletes the session object from the store and the storage

getSession(): Promise(session: object)

Returns the session object saved if there's any

initialized: boolean

Returns true if the session store has been initialized. Could be useful to check this property before relying on other methods or properties from the store.

hasSession: boolean

Returns true if there's a session object saved and false if there's not.

Contributing

Bug reports (please use Issues) and pull requests are welcome on GitHub at https://github.com/rootstrap/mobx-session. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The library is available as open source under the terms of the MIT License.

Credits

mobx-session is maintained by Rootstrap with the help of our contributors.