FixtureLibrary JS / TS

The JS/TS library for working our fork of the open-fixture-library.

The Documentation can be found here

Installation

Via NPM: npm i fixturelibrary && npx syncOfl

syncOfl executes a Script which then downloads all fixture definitions into the .fixturelibrary directory and populates an index with path and sha version references. If you don't want all fixtures downloaded and are fine with downloading them during runtime, you can use the shallow parameter: npx syncOfl shallow

When new fixtures get added to the Open-Fixture-Library just run npx syncOfl to update your index! If his script is executed to often, you might run into the GitHub rate limiter, and you'll have to try again after you wait some time.

Usage

For a more in depth documentation, please look here: FixtureLibrary

const { FixtureLibrary } = require('fixturelibrary');
const fl = new FixtureLibrary();

const fixture = await fl.getFixture('cameo/auro-spot-300');
console.log(`${fixture.name} has ${fixture.modes.length} Modes.`);

When working with Typescript, types for the fixture and all different capabilities can be found here.

Configuration

By default, in node the fixture library and a generated index will be generated inside node_modules. If you need to provide a different location (eg: for an electron build), you can specify the generated directory by setting the environment variable OFL_INDEX.