@norgate-av/react-crestron-ch5-hooks 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +96 -63
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +259 -0
- package/dist/index.d.ts +259 -2
- package/dist/index.js +1 -8
- package/package.json +41 -92
- package/dist/hooks/index.d.ts +0 -18
- package/dist/hooks/useCrestronAnalog/index.d.ts +0 -11
- package/dist/hooks/useCrestronAnalogCollection/index.d.ts +0 -12
- package/dist/hooks/useCrestronDigital/index.d.ts +0 -11
- package/dist/hooks/useCrestronDigitalCollection/index.d.ts +0 -12
- package/dist/hooks/useCrestronPublishAnalog/index.d.ts +0 -9
- package/dist/hooks/useCrestronPublishAnalogCollection/index.d.ts +0 -10
- package/dist/hooks/useCrestronPublishDigital/index.d.ts +0 -9
- package/dist/hooks/useCrestronPublishDigitalCollection/index.d.ts +0 -10
- package/dist/hooks/useCrestronPublishSerial/index.d.ts +0 -9
- package/dist/hooks/useCrestronPublishSerialCollection/index.d.ts +0 -10
- package/dist/hooks/useCrestronSerial/index.d.ts +0 -11
- package/dist/hooks/useCrestronSerialCollection/index.d.ts +0 -12
- package/dist/hooks/useCrestronSubscribeAnalog/index.d.ts +0 -11
- package/dist/hooks/useCrestronSubscribeAnalogCollection/index.d.ts +0 -12
- package/dist/hooks/useCrestronSubscribeDigital/index.d.ts +0 -11
- package/dist/hooks/useCrestronSubscribeDigitalCollection/index.d.ts +0 -12
- package/dist/hooks/useCrestronSubscribeSerial/index.d.ts +0 -11
- package/dist/hooks/useCrestronSubscribeSerialCollection/index.d.ts +0 -12
- package/dist/react-crestron-ch5-hooks.cjs.development.js +0 -643
- package/dist/react-crestron-ch5-hooks.cjs.development.js.map +0 -1
- package/dist/react-crestron-ch5-hooks.cjs.production.min.js +0 -2
- package/dist/react-crestron-ch5-hooks.cjs.production.min.js.map +0 -1
- package/dist/react-crestron-ch5-hooks.esm.js +0 -602
- package/dist/react-crestron-ch5-hooks.esm.js.map +0 -1
- package/dist/react-crestron-ch5-hooks.umd.development.js +0 -645
- package/dist/react-crestron-ch5-hooks.umd.development.js.map +0 -1
- package/dist/react-crestron-ch5-hooks.umd.production.min.js +0 -2
- package/dist/react-crestron-ch5-hooks.umd.production.min.js.map +0 -1
- package/dist/types/Analog/index.d.ts +0 -1
- package/dist/types/AnalogStateCallback/index.d.ts +0 -3
- package/dist/types/Digital/index.d.ts +0 -1
- package/dist/types/DigitalStateCallback/index.d.ts +0 -3
- package/dist/types/IAnalogEventAction/index.d.ts +0 -4
- package/dist/types/IAnalogSignal/index.d.ts +0 -5
- package/dist/types/IAnalogState/index.d.ts +0 -4
- package/dist/types/IBaseEventAction/index.d.ts +0 -3
- package/dist/types/IBaseSignal/index.d.ts +0 -4
- package/dist/types/IBaseState/index.d.ts +0 -3
- package/dist/types/IDigitalEventAction/index.d.ts +0 -7
- package/dist/types/IDigitalSignal/index.d.ts +0 -5
- package/dist/types/IDigitalState/index.d.ts +0 -4
- package/dist/types/ISerialEventAction/index.d.ts +0 -4
- package/dist/types/ISerialSignal/index.d.ts +0 -5
- package/dist/types/ISerialState/index.d.ts +0 -4
- package/dist/types/IStateSubscription/index.d.ts +0 -4
- package/dist/types/Serial/index.d.ts +0 -1
- package/dist/types/SerialStateCallback/index.d.ts +0 -3
- package/dist/types/StateCallback/index.d.ts +0 -1
- package/dist/types/index.d.ts +0 -20
- package/dist/utils/getSignalCollection.d.ts +0 -3
- package/dist/utils/index.d.ts +0 -1
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { AnalogStateCallback, IAnalogState } from "../../types";
|
|
2
|
-
/**
|
|
3
|
-
* `useCrestronSubscribeAnalogCollection` is a hook that returns an array of objects each with a value property.
|
|
4
|
-
* @param {string[]} signalNames - An array of strings that represent the names of the signals you want
|
|
5
|
-
* to subscribe to.
|
|
6
|
-
* @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the
|
|
7
|
-
* state changes.
|
|
8
|
-
* @returns An array of IAnalogState objects.
|
|
9
|
-
*/
|
|
10
|
-
export declare function useCrestronSubscribeAnalogCollection(signalNames: string[], callback?: AnalogStateCallback): IAnalogState[];
|
|
11
|
-
export default useCrestronSubscribeAnalogCollection;
|
|
12
|
-
export declare const useCrestronSubscribeNumberCollection: typeof useCrestronSubscribeAnalogCollection;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { DigitalStateCallback, IDigitalState } from "../../types";
|
|
2
|
-
/**
|
|
3
|
-
* `useCrestronSubscribeDigital` is a hook that returns an object with a value property.
|
|
4
|
-
* @param {string} signalName - The name of the signal you want to subscribe to.
|
|
5
|
-
* @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the state
|
|
6
|
-
* changes.
|
|
7
|
-
* @returns An array with a single IDigitalState object.
|
|
8
|
-
*/
|
|
9
|
-
export declare function useCrestronSubscribeDigital(signalName: string, callback?: DigitalStateCallback): [IDigitalState];
|
|
10
|
-
export default useCrestronSubscribeDigital;
|
|
11
|
-
export declare const useCrestronSubscribeBoolean: typeof useCrestronSubscribeDigital;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { DigitalStateCallback, IDigitalState } from "../../types";
|
|
2
|
-
/**
|
|
3
|
-
* `useCrestronSubscribeDigitalCollection` is a hook that returns an array of objects each with a value property.
|
|
4
|
-
* @param {string[]} signalNames - An array of strings that represent the names of the signals you want
|
|
5
|
-
* to subscribe to.
|
|
6
|
-
* @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the
|
|
7
|
-
* state changes.
|
|
8
|
-
* @returns An array of IDigitalState objects.
|
|
9
|
-
*/
|
|
10
|
-
export declare function useCrestronSubscribeDigitalCollection(signalNames: string[], callback?: DigitalStateCallback): IDigitalState[];
|
|
11
|
-
export default useCrestronSubscribeDigitalCollection;
|
|
12
|
-
export declare const useCrestronSubscribeBooleanCollection: typeof useCrestronSubscribeDigitalCollection;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { ISerialState, SerialStateCallback } from "../../types";
|
|
2
|
-
/**
|
|
3
|
-
* `useCrestronSubscribeSerial` is a hook that returns an object with a value property.
|
|
4
|
-
* @param {string} signalName - The name of the signal you want to subscribe to.
|
|
5
|
-
* @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the state
|
|
6
|
-
* changes.
|
|
7
|
-
* @returns An array with a single ISerialState object.
|
|
8
|
-
*/
|
|
9
|
-
export declare function useCrestronSubscribeSerial(signalName: string, callback?: SerialStateCallback): [ISerialState];
|
|
10
|
-
export default useCrestronSubscribeSerial;
|
|
11
|
-
export declare const useCrestronSubscribeString: typeof useCrestronSubscribeSerial;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { SerialStateCallback, ISerialState } from "../../types";
|
|
2
|
-
/**
|
|
3
|
-
* `useCrestronSubscribeSerialCollection` is a hook that returns an array of objects each with a value property.
|
|
4
|
-
* @param {string[]} signalNames - An array of strings that represent the names of the signals you want
|
|
5
|
-
* to subscribe to.
|
|
6
|
-
* @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the
|
|
7
|
-
* state changes.
|
|
8
|
-
* @returns An array of ISerialState objects.
|
|
9
|
-
*/
|
|
10
|
-
export declare function useCrestronSubscribeSerialCollection(signalNames: string[], callback?: SerialStateCallback): ISerialState[];
|
|
11
|
-
export default useCrestronSubscribeSerialCollection;
|
|
12
|
-
export declare const useCrestronSubscribeStringCollection: typeof useCrestronSubscribeSerialCollection;
|