mirror of
https://github.com/parnic/node-intellicenter.git
synced 2025-06-16 10:10:13 -05:00
Parnic
c445a844ee
This allows require() and import to work for even better compatibility between CJS and ESM consumers. I dislike that this kills our ability for top-level awaits in example.ts, but seeing as how my primary use case for this library is a commonjs module, I think this is a fair trade-off. Also changed "messages" to not encapsulate its export under the name "messages" to remove some repetition in importing "messages" and still needing to do "messages." to get the methods out. Now it's simple to import each message by name or group them under something like "messages" as desired on a per-library-user basis. Refs: * https://www.kravchyk.com/typescript-npm-package-json-exports/ * https://arethetypeswrong.github.io/ * https://evertpot.com/universal-commonjs-esm-typescript-packages/
22 lines
944 B
JavaScript
22 lines
944 B
JavaScript
import { GetRequest } from "./request.js";
|
|
/**
|
|
* Requests the configuration of bodies and circuits available to this controller.
|
|
*
|
|
* The response contains the list of bodies and circuits under the `answer` field.
|
|
* Each object has an `objnam` that should be used to reference that object for future requests,
|
|
* and `params`.`SNAME` is the user-entered friendly name that can be displayed for the object.
|
|
* `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the object it's describing.
|
|
*
|
|
* Some objects, such as the Pool body, will have the `params`.`OBJLIST` array populated with
|
|
* a series of attached objects such as a chlorinator device.
|
|
*
|
|
* @returns the object used to issue this request
|
|
*/
|
|
export function GetSystemConfiguration() {
|
|
const req = GetRequest();
|
|
req.command = "GetQuery";
|
|
req.queryName = "GetConfiguration";
|
|
req.arguments = "";
|
|
return req;
|
|
}
|
|
//# sourceMappingURL=configuration.js.map
|