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

@bemedev/x-matches

v0.0.3

Published

Better way to macth states in XState

Downloads

49

Readme

Better way to macth states in XState

Short introduction to Xstate

XState is a implementation of Statecharts, a graphical way to represent complexity in code. Every you need to know is inside the docs.

Problems

  • [x] Orthogonal/parallel state

To matches a parallel state, you need to put as parameter an entire object. Generally, you only need to know if the state is inside a child or a grandchild of the current state. XState is recursive, so for a small check, you can write a deep recursive object as parameter with infinite nested children.

  • [x] Compound state

It’s the same problem as orthogonal but with less complexity. Here, I want to emphasize the problem of nested objects. Sometimes you only need to know if the state is inside the parent and you don’t care about the children. But in the current configuration of state.matches, you need to put as parameter and the nested current children.

  • [ ] Direct implementation polyfill for core XState

Not yet implemented

The solution

A function to match with string representation of the current state or parent, or grandparent 😌😵‍💫, or… You see where I want to go!

I listed the cases inside this code block :

import buildMatches from '@bemedev/x-matches';

// Case 1 -> simple state
const simpleMatch = buildMatches('idle');

// Case 2 -> compound state
const compoundMatch = buildMatches({
  fetching: {
    parent: 'child',
  },
});

// Case 3 -> parallel state
const parallelMatch = buildMatches({
  auth: {
    /* ... */
  },
  fetching: {
    /* ... */
  },
});

// The resulting function accepts a param array :
parallelMacth('auth', 'fetching');
compoundMatch('fetching', 'fetching.parent', 'fetching.parent.child');

Add-ons

We add possibilities to do logical "or" and logical "and"

Code example:

import buildMatches from '@bemedev/x-matches';

// Case 3 -> parallel state
const matches = buildMatches({
  auth: 'notAuthenticated',
  fetching: {
    cache: 'nodata',
    backend: 'data',
  },
});

matches({ or: ['auth', 'fetching.cache.data'] }); // => true

matches({
  and: ['auth.notAuthenticated', 'fetching.cache.data'],
}); // => false

matches(
  {
    and: ['auth.notAuthenticated', 'fetching.cache.data'],
  },
  'auth',
); // => false

matches(
  {
    or: ['auth', 'fetching.cache.data'],
  },
  'fetching',
); // => true

matches({
  and: [
    {
      or: ['auth', 'fetching.cache.data'],
    },
    'fetching',
  ],
}); // => true

NB : The param array acts like a logical "and"

Live documentation here

Enjoy your function ✌🏾😎 !