@norgate-av/react-crestron-ch5-hooks 1.0.0

package/dist/hooks/index.d.ts

@@ -0,0 +1,18 @@
+export * from "./useCrestronAnalog";
+export * from "./useCrestronDigital";
+export * from "./useCrestronSerial";
+export * from "./useCrestronAnalogCollection";
+export * from "./useCrestronDigitalCollection";
+export * from "./useCrestronSerialCollection";
+export * from "./useCrestronPublishAnalog";
+export * from "./useCrestronPublishDigital";
+export * from "./useCrestronPublishSerial";
+export * from "./useCrestronPublishAnalogCollection";
+export * from "./useCrestronPublishDigitalCollection";
+export * from "./useCrestronPublishSerialCollection";
+export * from "./useCrestronSubscribeAnalog";
+export * from "./useCrestronSubscribeDigital";
+export * from "./useCrestronSubscribeSerial";
+export * from "./useCrestronSubscribeAnalogCollection";
+export * from "./useCrestronSubscribeDigitalCollection";
+export * from "./useCrestronSubscribeSerialCollection";

package/dist/hooks/useCrestronAnalog/index.d.ts

@@ -0,0 +1,11 @@
+import { AnalogStateCallback, IAnalogSignal } from "../../types";
+/**
+ * `useCrestronAnalog` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single IAnalogSignal object.
+ */
+export declare function useCrestronAnalog(signalName: string, callback?: AnalogStateCallback): [IAnalogSignal];
+export default useCrestronAnalog;
+export declare const useCrestronNumber: typeof useCrestronAnalog;

package/dist/hooks/useCrestronAnalogCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { AnalogStateCallback, IAnalogSignal } from "../../types";
+/**
+ * `useCrestronAnalogCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {AnalogStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of IAnalogSignal objects.
+ */
+export declare function useCrestronAnalogCollection(signalNames: string[], callback?: AnalogStateCallback): IAnalogSignal[];
+export default useCrestronAnalogCollection;
+export declare const useCrestronNumberCollection: typeof useCrestronAnalogCollection;

package/dist/hooks/useCrestronDigital/index.d.ts

@@ -0,0 +1,11 @@
+import { DigitalStateCallback, IDigitalSignal } from "../../types";
+/**
+ * `useCrestronDigital` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single IDigitalSignal object
+ */
+export declare function useCrestronDigital(signalName: string, callback?: DigitalStateCallback): [IDigitalSignal];
+export default useCrestronDigital;
+export declare const useCrestronBoolean: typeof useCrestronDigital;

package/dist/hooks/useCrestronDigitalCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { DigitalStateCallback, IDigitalSignal } from "../../types";
+/**
+ * `useCrestronDigitalCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {DigitalStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of IDigitalSignal objects.
+ */
+export declare function useCrestronDigitalCollection(signalNames: string[], callback?: DigitalStateCallback): IDigitalSignal[];
+export default useCrestronDigitalCollection;
+export declare const useCrestronBooleanCollection: typeof useCrestronDigitalCollection;

package/dist/hooks/useCrestronPublishAnalog/index.d.ts

@@ -0,0 +1,9 @@
+import { IAnalogEventAction } from "../../types";
+/**
+ * `useCrestronPublishAnalog` is a hook that returns an object with a setValue function.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single IAnalogEventAction object.
+ */
+export declare function useCrestronPublishAnalog(signalName: string): [IAnalogEventAction];
+export default useCrestronPublishAnalog;
+export declare const useCrestronPublishNumber: typeof useCrestronPublishAnalog;

package/dist/hooks/useCrestronPublishAnalogCollection/index.d.ts

@@ -0,0 +1,10 @@
+import { IAnalogEventAction } from "../../types";
+/**
+ * `useCrestronPublishAnalogCollection` is a hook that returns an array of objects each with a setValue function.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of IAnalogEventAction objects.
+ */
+export declare function useCrestronPublishAnalogCollection(signalNames: string[]): IAnalogEventAction[];
+export default useCrestronPublishAnalogCollection;
+export declare const useCrestronPublishNumberCollection: typeof useCrestronPublishAnalogCollection;

package/dist/hooks/useCrestronPublishDigital/index.d.ts

@@ -0,0 +1,9 @@
+import { IDigitalEventAction } from "../../types";
+/**
+ * `useCrestronPublishDigital` is a hook that returns an object with setValue, push, release and click functions.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single IDigitalEventAction object.
+ */
+export declare function useCrestronPublishDigital(signalName: string): [IDigitalEventAction];
+export default useCrestronPublishDigital;
+export declare const useCrestronPublishBoolean: typeof useCrestronPublishDigital;

package/dist/hooks/useCrestronPublishDigitalCollection/index.d.ts

@@ -0,0 +1,10 @@
+import { IDigitalEventAction } from "../../types";
+/**
+ * `useCrestronPublishDigitalCollection` is a hook that returns an array of objects each with setValue, push, release and click functions.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of IDigitalEventAction objects.
+ */
+export declare function useCrestronPublishDigitalCollection(signalNames: string[]): IDigitalEventAction[];
+export default useCrestronPublishDigitalCollection;
+export declare const useCrestronPublishBooleanCollection: typeof useCrestronPublishDigitalCollection;

package/dist/hooks/useCrestronPublishSerial/index.d.ts

@@ -0,0 +1,9 @@
+import { ISerialEventAction } from "../../types";
+/**
+ * `useCrestronPublishSerial` is a hook that returns an object with a setValue function.
+ * @param {string} signalName - The name of the signal you want to publish to.
+ * @returns An array with a single ISerialEventAction object.
+ */
+export declare function useCrestronPublishSerial(signalName: string): [ISerialEventAction];
+export default useCrestronPublishSerial;
+export declare const useCrestronPublishString: typeof useCrestronPublishSerial;

package/dist/hooks/useCrestronPublishSerialCollection/index.d.ts

@@ -0,0 +1,10 @@
+import { ISerialEventAction } from "../../types";
+/**
+ * `useCrestronPublishSerialCollection` is a hook that returns an array of objects each with a setValue function.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to publish to.
+ * @returns An array of ISerialEventAction objects.
+ */
+export declare function useCrestronPublishSerialCollection(signalNames: string[]): ISerialEventAction[];
+export default useCrestronPublishSerialCollection;
+export declare const useCrestronPublishStringCollection: typeof useCrestronPublishSerialCollection;

package/dist/hooks/useCrestronSerial/index.d.ts

@@ -0,0 +1,11 @@
+import { ISerialSignal, SerialStateCallback } from "../../types";
+/**
+ * `useCrestronSerial` is a hook that returns an object with a state and action property.
+ * @param {string} signalName - The name of the signal you want to use.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the state of the signal
+ * changes.
+ * @returns An array with a single ISerialSignal object.
+ */
+export declare function useCrestronSerial(signalName: string, callback?: SerialStateCallback): [ISerialSignal];
+export default useCrestronSerial;
+export declare const useCrestronString: typeof useCrestronSerial;

package/dist/hooks/useCrestronSerialCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { ISerialSignal, SerialStateCallback } from "../../types";
+/**
+ * `useCrestronSerialCollection` is a hook that returns an array of objects each with state and action properties.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to use.
+ * @param {SerialStateCallback} [callback] - A optional callback function that will be called whenever the state of
+ * the signal changes.
+ * @returns An array of ISerialSignal objects.
+ */
+export declare function useCrestronSerialCollection(signalNames: string[], callback?: SerialStateCallback): ISerialSignal[];
+export default useCrestronSerialCollection;
+export declare const useCrestronStringCollection: typeof useCrestronSerialCollection;

package/dist/hooks/useCrestronSubscribeAnalog/index.d.ts

@@ -0,0 +1,11 @@
+import { AnalogStateCallback, IAnalogState } from "../../types";
+/**
+ * `useCrestronSubscribeAnalog` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single IAnalogState object.
+ */
+export declare function useCrestronSubscribeAnalog(signalName: string, callback?: AnalogStateCallback): [IAnalogState];
+export default useCrestronSubscribeAnalog;
+export declare const useCrestronSubscribeNumber: typeof useCrestronSubscribeAnalog;

package/dist/hooks/useCrestronSubscribeAnalogCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { AnalogStateCallback, IAnalogState } from "../../types";
+/**
+ * `useCrestronSubscribeAnalogCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {AnalogStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of IAnalogState objects.
+ */
+export declare function useCrestronSubscribeAnalogCollection(signalNames: string[], callback?: AnalogStateCallback): IAnalogState[];
+export default useCrestronSubscribeAnalogCollection;
+export declare const useCrestronSubscribeNumberCollection: typeof useCrestronSubscribeAnalogCollection;

package/dist/hooks/useCrestronSubscribeDigital/index.d.ts

@@ -0,0 +1,11 @@
+import { DigitalStateCallback, IDigitalState } from "../../types";
+/**
+ * `useCrestronSubscribeDigital` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single IDigitalState object.
+ */
+export declare function useCrestronSubscribeDigital(signalName: string, callback?: DigitalStateCallback): [IDigitalState];
+export default useCrestronSubscribeDigital;
+export declare const useCrestronSubscribeBoolean: typeof useCrestronSubscribeDigital;

package/dist/hooks/useCrestronSubscribeDigitalCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { DigitalStateCallback, IDigitalState } from "../../types";
+/**
+ * `useCrestronSubscribeDigitalCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {DigitalStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of IDigitalState objects.
+ */
+export declare function useCrestronSubscribeDigitalCollection(signalNames: string[], callback?: DigitalStateCallback): IDigitalState[];
+export default useCrestronSubscribeDigitalCollection;
+export declare const useCrestronSubscribeBooleanCollection: typeof useCrestronSubscribeDigitalCollection;

package/dist/hooks/useCrestronSubscribeSerial/index.d.ts

@@ -0,0 +1,11 @@
+import { ISerialState, SerialStateCallback } from "../../types";
+/**
+ * `useCrestronSubscribeSerial` is a hook that returns an object with a value property.
+ * @param {string} signalName - The name of the signal you want to subscribe to.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the state
+ * changes.
+ * @returns An array with a single ISerialState object.
+ */
+export declare function useCrestronSubscribeSerial(signalName: string, callback?: SerialStateCallback): [ISerialState];
+export default useCrestronSubscribeSerial;
+export declare const useCrestronSubscribeString: typeof useCrestronSubscribeSerial;

package/dist/hooks/useCrestronSubscribeSerialCollection/index.d.ts

@@ -0,0 +1,12 @@
+import { SerialStateCallback, ISerialState } from "../../types";
+/**
+ * `useCrestronSubscribeSerialCollection` is a hook that returns an array of objects each with a value property.
+ * @param {string[]} signalNames - An array of strings that represent the names of the signals you want
+ * to subscribe to.
+ * @param {SerialStateCallback} [callback] - An optional callback function that will be called whenever the
+ * state changes.
+ * @returns An array of ISerialState objects.
+ */
+export declare function useCrestronSubscribeSerialCollection(signalNames: string[], callback?: SerialStateCallback): ISerialState[];
+export default useCrestronSubscribeSerialCollection;
+export declare const useCrestronSubscribeStringCollection: typeof useCrestronSubscribeSerialCollection;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./hooks";
+export * from "./types";

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./react-crestron-ch5-hooks.cjs.production.min.js')
+} else {
+  module.exports = require('./react-crestron-ch5-hooks.cjs.development.js')
+}