@norgate-av/ch5-join-getter
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

ch5-join-getter

ch5-logo

CI Conventional Commits Commitizen friendly GitHub contributors MIT license


Dynamically get all the latest CH5 reserved join data from the CH5 json file at https://siproducts.blob.core.windows.net/ch5-release/rjviewapp.json.

This package is intended to be used as a test helper for crestron-ch5-helper to test for changes in the reserved join data.

Contents 📖

Installation ⚡

npm install --save-dev @norgate-av/ch5-join-getter

# or

yarn add -D @norgate-av/ch5-join-getter

# or

pnpm add -D @norgate-av/ch5-join-getter

Usage 🚀

The package exports a single function getReservedJoinData which returns a promise that resolves to the latest reserved join data.

import { getReservedJoinData } from "@norgate-av/ch5-join-getter";

const data = await getReservedJoinData();

console.log(data.ReservedJoin.Analog.Event);
console.log(data.ReservedJoin.Digital.Event);
console.log(data.ReservedJoin.Serial.Event);

console.log(data.ReservedJoin.Analog.State);
console.log(data.ReservedJoin.Digital.State);
console.log(data.ReservedJoin.Serial.State);

Team ⚽

This project is maintained by the following person(s) and a bunch of awesome contributors.


Damien Butt

Contributors ✨

All Contributors

Thanks go to these awesome people (emoji key):

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE ⚖️

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i @norgate-av/ch5-join-getter

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

9.3 kB

Total Files

7

Last publish

Collaborators

  • damienbutt