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

motel

v1.0.2

Published

data-vacancy observer

Downloads

52

Readme

Motel: Side-effect free data-fetching

Remote data dependencies

React is a function of state, so one of our jobs as developers is making that state available. Sometimes it's available locally; either hard-coded in the source or provided by the user. Other times it's available remotely; for example stored in the cloud. These remote data dependencies are essentially the "R" in CRUD.

The vacancy observer pattern

Typically, in order to know when to fetch remote data dependencies, we're forced to use lifecycle events, which are side effects. This lib uses the vacancy observer pattern to fetch remote data dependencies without side effects, thus keeping UI logic closer to the pure function of application state ideal.

Prerequisites

This lib has no dependencies or requirements of React.

The prerequisite is rather that you're using an approach where state is managed centrally, and where UI components are a pure function of application state. React+Redux and Elm are both examples of this.

Installation

npm install motel

API Documentation

Documentation is available under the docs/ folder of this repo, and also online.

Quick Example

In your main.js entry-point

Import or require this library.

import Motel from 'motel';
const Motel = require('motel');

Grab a reference to the "mount node" of your app.

const mountNode = document.querySelector('#root');

Initialize the motel instance. This exists for the lifetime of the app.

const vacancies = Motel.create();

Setup handler for all vacancies as they occur.

vacancies.observe('*', (url, dispatch) => {
  dispatch({ type: 'requested', url });
  const response = await fetcfh(url);
  const data = await response.json();
  dispatch({ type: 'received', url, data });
});

Capture the output of the above callbacks.

vacancies.subscribe(action => store.dipatch(action));

Start observing vacancies on the DOM subtree of the mount node.

vacancies.connect(mountNode);

In any React component

Simply render data vacancies on any component with a remote data dependency.

function UserProfile(props) {
  return (
    <div data-vacancy="/api/users/xxxxxxxx">
      ...content here...
    </div>
  );
}

Further examples

For more in-depth examples, refer to examples.md in this same repo.