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

@bluemarblepayroll/short-term-memory

v1.0.0

Published

Isomorphic Session Storage

Downloads

1

Readme

Short Term Memory

Isomorphic Session Storage

Build Status

Very small library that places a layer of abstraction over the browsers built in Session Storage API. This means you can program to this library and it will ensure you do not make any hard links between your application and the browser. When this is ran outside of a browser then it will polyfill the storage with an in-memory key-value store.

Note that this library only deals with short-lived storage (Session Storage) and does not currently deal with longer term storage (i.e. Local Storage).

Installation

This library could be consumed as either a pure TypeScript library or as its trans-compiled ES2015 JavaScript counterpart.

To install through NPM:

npm install --save @bluemarblepayroll/short-term-memory

To install through Yarn:

yarn add @bluemarblepayroll/short-term-memory

Examples

The Store API is meant to implement the main SessionStorage API methods:

  1. getItem
  2. setItem
  3. removeItem
  4. clear

The other methods, such as key and length, were purposely omitted from the initial implementation. These methods can be added later should the need arise.

Storing & Retrieving Values

import StorageManager from "@bluemarblepayroll/short-term-memory";

StorageManager.setItem('Iron Man', 'Tony Stark');

let ironMansName = StorageManager.getItem('Iron Man'); // returns 'Tony Stark'

Removing Values

import StorageManager from "@bluemarblepayroll/short-term-memory";

StorageManager.setItem('Iron Man', 'Tony Stark');

StorageManager.removeItem('Iron Man');

let ironMansName = StorageManager.getItem('Iron Man'); // returns null

Clearing

import StorageManager from "@bluemarblepayroll/short-term-memory";

StorageManager.setItem('Iron Man', 'Tony Stark');
StorageManager.setItem('Hulk', 'Bruce Banner');

StorageManager.clear();

let ironMansName = StorageManager.getItem('Iron Man'); // returns null
let hulksName = StorageManager.getItem('Hulk'); // returns null

Contributing

Development Environment Configuration

Basic steps to take to get this repository compiling:

  1. Install Node.js (check package.json for versions supported.)
  2. Install Yarn package manager: npm install -g yarn
  3. Clone the repository: git clone [email protected]:bluemarblepayroll/short-term-memory.git
  4. Navigate to the root folder: cd short-term-memory
  5. Install dependencies: yarn

Compiling

To compile the TypeScript source down to native JavaScript, run:

yarn run build

Running Tests

To execute the test suite run:

yarn run test

Linting

yarn run lint

Publishing

Note: ensure you have proper authorization before trying to publish new versions.

After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:

  1. Merge Pull Request into master
  2. Update package.json version number
  3. Update CHANGELOG.md
  4. Push master to remote and ensure CI builds master successfully
  5. Build the project locally: yarn run build
  6. Perform a dry run: npm publish --access public --dry-run. Inspect packaging, ensure all files (including dist) are included.
  7. Publish package to NPM: npm publish --access public
  8. Tag master with new version: git tag <version>
  9. Push tags remotely: git push origin --tags

License

This project is MIT Licensed.