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

@ficusjs/finite-state-machine

v1.0.1

Published

Finite State Machine in TypeScript

Downloads

3

Readme

Finite state machine

A lightweight finite state machine library. It is based on the @xstate/fsm library.

What is a finite state machine?

A finite state machine is a finite set of states that can transition to each other deterministically due to events.

A state machine service is responsible for interpreting the state machine and turning it into a running instance. The service takes care of:

  • starting and stopping the state machine
  • keeping track of state
  • transitioning between states
  • updating context data
  • executing actions
  • invoking callbacks
  • notifying subscribers

Features

  • [x] State machine instance
  • [x] State machine service (running state machine)
  • [x] Subscription to state changes
  • [x] Transitions
  • [x] Self transitions
  • [x] Trigger transitions with string
  • [x] Trigger transitions with object
  • [x] Transition actions
  • [x] Context
  • [x] Guards
  • [x] Entry and exit actions

Installation

FicusJS finite state machine is part of FicusJS but can also be installed independently in a number of ways.

CDN

We recommend using native ES modules in the browser.

<script type="module">
  import {
    createMachine,
    createMachineService,
    assign,
    interpret
  } from 'https://cdn.skypack.dev/@ficusjs/finite-state-machine'
</script>

FicusJS finite state machine is available on Skypack.

NPM

FicusJS finite state machine works nicely with build tools such as Parcel, Webpack or Rollup. If you are using a NodeJS tool, you can install the NPM package.

npm install @ficusjs/finite-state-machine

Available builds

FicusJS finite state machine only provides ES module builds. For legacy browsers or alternative modules such as CommonJS, it is recommended to use a build tool to transpile the code.

Usage

import { createMachine, createMachineService, assign } from '@ficusjs/finite-state-machine'

const lightMachine = createMachine({
  initial: 'green',
  states: {
    green: {
      on: {
        TIMER: {
          target: 'yellow'
        }
      }
    },
    yellow: {
      on: {
        TIMER: {
          target: 'red'
        }
      }
    },
    red: {
      on: {
        TIMER: {
          target: 'green'
        }
      }
    }
  }
})

const service = createMachineService('lights', lightMachine)
  .subscribe((state) => {
    console.log(state.value);
  })
  .start()

// => 'green'
// => 'yellow'
// => 'red'
// => 'green'

service.send('TIMER')
service.send('TIMER')
service.send('TIMER')

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing to FicusJS

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can work on any features you think would enhance the library. After adding your code, please send us a Pull Request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

Support

We all need support and motivation. FicusJS is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the library helpful, please consider sponsoring us.