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

simple-iso

v0.1.3

Published

A lightweight container for consistently sharing state between servers and browsers

Downloads

2

Readme

Simple Iso Build status

A lightweight container for consistently sharing state between servers and browsers.

Installation

npm i simple-iso --save

Usage

In order for an object to be hydratable (have its state stored and reused elsewhere at a later time), it must implement a serialise method. This represents the data that one wishes to share with the browser:

class ImageRepository {
	constructor(images) {
		this._images = images || [];
	}

	serialise() {
		return this._images;
	}
}

In your server code, import the container and add any references that you'll require across the server and client. Then pass the container's serialisation, using iso.serialise() in your response. For example, when using Express:

import express from 'express';
import iso from 'simple-iso';
import ImageRepository from './images/ImageRepository';
const app = express();

[...]
/* adding a mapping for the ImageRepository
 * prototype and its associated serialisation */
iso.add(new ImageRepository());

app.get('/', (req, res) => {
	res.status(200).render('images.handlebars', {
		appState: iso.serialise(); // gets the latest serialisation of ALL objects added to the container
	});
});

In the above example, images.handlebars should inject the state into a script tag:

[...]

<script>
{{{ appState }}}
</script>

Then, to retrieve a new instance with the injected state in the browser, call iso.hydrate on the type:

// FYI - I'm using Browserify and Babel for generating my client-side code
import iso from 'simple-iso';
import ImageRepository from './images/ImageRepository';

const repository = iso.hydrate(ImageRepository);

Whenever an instance added to the store receives new data, one should invoke iso.update to ensure that the server and client are both synchronised with the latest updates. Thus, in the hypothetical ImageRepository:

class ImageRepository {
	[...]

	onNewImage(image) {
		this._images.push(image);
		iso.update(this);
	}
}

Examples

Consult my fashion-timeline project for an example of integrating Simple Iso. Alternatively, check out my breaking-news repo. This doesn't use the library explicitly, but contains the initial implementation of the container, and it honours the same contract.

Building locally

There are some build scripts written using Bash. These invoke the Babel and Mocha CLIs, which can be installed with npm i -g mocha babel. Then install the local dependencies using npm i.

The available tasks are:

  • npm run build - compile the source to ECMAScript 5
  • npm test - compile the source and run the unit tests