NodeCG-RX

NodeCG-RX is a wrapper for NodeCG-Replicants. It supports wrapping NodeCG-Replicants in RxJS-Observables or RxJS-Subjects.

Installation

Use the package manager npm to install this project.

npm install --save nodecg-rx

Usage

Use ReplicantObservable to wrap a Replicant into an Observable.

const observable = new ReplicantObservable<any>(nodecg.Replicant('observable'));

Use ReplicantSubject to wrap a Replicant into a Subject.

const subject = new ReplicantSubject<any>(nodecg.Relicant('subject'));

Building

Use the build script to build this project.

npm run build

Testing

Use the test script to build this project.

npm run test

Built With

• webpack - a bundler for javascript and friends
• RxJS - a library for reactive programming using Observables, to make it easier to compose asynchronous or callback-based code
• NodeCG - a broadcast graphics framework and application

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under LGPL-3.0.