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

@unleash/yggdrasil

v0.1.0-beta.2

Published

Direct bindings to the Yggdrasil grammar for NodeJS

Downloads

1

Readme

Wasm Engine

Introduction

This project is a simple WASM cross compilation of the Yggdrasil engine.

Currently, this only supports direct access to the Yggdrasil rule grammar, and is not a full implementation of the Unleash logic.

Please note that this is an experimental project and the API is subject to change rapidly as we iterate on the ideas here.

Usage

First, install the package:

$ yarn add @unleash/yggdrasil-engine

Then, you can use it in your code:

  const yggdrasil = require("../pkg/wasm_engine.js");

  const context = {
    userId: "7",
  };

  const ruleEnabled = yggdrasil.evaluate("user_id > 6", context); //returns true
  const ruleEnabled = yggdrasil.evaluate("user_id > 8", context); //returns false
  const ruleEnabled = yggdrasil.evaluate("some rule that is nonsense", context); //raises an error

Rule fragments that are passed to the evaluate function must be valid Yggdrasil rules; rules that are invalid will raise an error. Valid rules will always result in a boolean value when evaluated.

Context properties

Currently the context is built to match the Unleash Context, so the special properties that are supported are:

| Property Name | Use in Unleash | | --- |--- | | environment | the environment the app is running in | | userId | an identifier for the current user | | sessionId | identifier for the current session | | remoteAddress | the app's IP address | | currentTime | the current time in ISO format | | properties | a key-value store of any data you want |

You don't have to use any of these if they have no meaning to you, using the properties object is the most flexible way to pass data into the engine but it does mean the rules you need to produce are slightly more verbose:

  const context = {
    properties: {
      customProperty: "7",
    },
  };

  const result = yggdrasil.evaluate('context["customProperty"] > 6', context); // matches the "customProperty" field on the context and returns true

Please note that you must pass a context object, even if it is empty. Failure to do so will result in an error being raised by the engine.

Development

This project uses wasm-bindgen to generate the Rust/JS bindings. To build the project, run:

$ wasm-pack build --target nodejs --scope public

Running tests can be done with:

$ wasm-pack test --node

There's also a set of integration tests in the e2e-tests directory, which will ensure that the WASM module can be loaded and used in Node JS and that calls to the engine are correctly managed. These must be run within the e2e-tests directory:

$ cd e2e-tests
$ yarn jest