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

@gamestdio/state-listener

v3.1.0

Published

Deeply compare JavaScript objects and listen to changes.

Downloads

464

Readme

@gamestdio/state-listener Build status

Deeply compare JavaScript objects and listen to changes. Used in colyseus.js

Sauce Test Status

Usage

This library is meant for listening to changes in a JavaScript object.

import { StateContainer } from "@gamestdio/state-listener"

// Create the container instance.
let container = new StateContainer({
    entities: {
        one: { x: 10, y: 10 }
    }
});

Listening to changes

container.listen("entities/:id/:attribute", (change: DataChange) => {
    console.log(change.path.id, change.path.attribute, change.operation, change.value);
});

// Setting new data into the container will trigger the matching listeners
container.set({ entities: { one: { x: 20 } } });

// Console output
// => "one", "x", "replace", 20
// => "one", "y", "remove", undefined

On this example, two properties has been changed ("entities/one/x", and "entities/one/y"). Thus, the callback will be triggered twice.

Fallback listener

You can use a fallback listener when you're not sure how exactly the change will come. Useful during development process.

Please note that change.path in the fallback listener will be an array containing the full path to the property that has changed.

container.listen((change: DataChange) => {
    console.log(change.path, change.operation, change.value);
})

// Setting new data into the container will trigger the matching listeners
container.set({ entities: { one: { x: 20 } } });

// Console output
// => ["entities", "one", "x"], "replace", 20
// => ["entities", "one", "y"], "remove", undefined

See tests for more usage examples.

Registering custom placeholders

Registering the placeholder:

container.registerPlaceholder(":xyz", /([xyz])/);

Using the matcher:

container.listen("entity/:id/:xyz", (change: DataChange) => {
    myEntities[ change.path.id ][ change.path.xyz ] = change.value;
});

Built-in placeholders

  • :id: /([a-zA-Z0-9\-_]+)/
  • :number: /([0-9]+)/
  • :string: /(\w+)/
  • :axis: /^([xyz])$/
  • :*: /(.*)/

When any other name is used starting with : (e.g. :example), * will be used by default.

Inspiration

The compare method is highly based on fast-json-patch implementation.

License

MIT