@first-lego-league/ms-configuration

A configuration package supporting the MS (Module Standard)

Stats

StarsIssuesVersionUpdatedCreatedSize
@first-lego-league/ms-configuration
2.4.0a year ago3 years agoMinified + gzip package size for @first-lego-league/ms-configuration in KB

Readme

npm codecov Build status GitHub

David Dependency Status David Dev Dependency Status David Peer Dependencies Status

FIRST LEGO League Configuration

A Configuration package, working according to the FIRST LEGO League TMS Module Standard configuration section.

Logic

This package is connected to the Launcher configuration MHub node, using the ms-messenger package. It holds an in-memory state of the configuration data saved in the launcher, and allows the user to both get and set it, using MHub messages.

Usage

You can set and get fields in the following ways:

const config = require('@first-lego-league/ms-configuration')
config.set('some-field-name', someFieldValue)
config.setMultiple([{ name: 'field1-name', value: 'field1-value' }, { name: 'field2-name', value: 'field2-value' }, ...])

config.get('some-field-name') // returns field value
config.all() // returns an object of key-value pairs containing all of the configuration field names.

Contribution

To contribute to this repository, simply create a PR and set one of the Code Owners to be a reviewer. Please notice the linting and UT, because they block merge. Keep the package lightweight and easy to use. Thank you for contributing!

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.