Skip to content

Commit 998fedd

Browse files
authored
fix: linting of types declaration file (#367)
1 parent 1823dfb commit 998fedd

File tree

1 file changed

+63
-111
lines changed

1 file changed

+63
-111
lines changed

types/openzwave-shared.d.ts

Lines changed: 63 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ declare module "openzwave-shared" {
2626
loc: string;
2727
}
2828

29-
export interface ChangeLogEntry
30-
{
29+
export interface ChangeLogEntry {
3130
author: string;
3231
date: string;
3332
revision: number;
@@ -41,7 +40,7 @@ declare module "openzwave-shared" {
4140
NodeAwake = 3,
4241
NodeSleep = 4,
4342
NodeDead = 5,
44-
NodeAlive = 6
43+
NodeAlive = 6,
4544
}
4645

4746
export enum ControllerState {
@@ -55,7 +54,7 @@ declare module "openzwave-shared" {
5554
Completed = 7,
5655
Failed = 8,
5756
NodeOK = 9,
58-
NodeFailed = 10
57+
NodeFailed = 10,
5958
}
6059

6160
export enum LogLevel {
@@ -68,7 +67,7 @@ declare module "openzwave-shared" {
6867
InfoMessagesAndHigher = 6,
6968
DetailedMessagesAndHigher = 7,
7069
DebugMessagesAndHigher = 8,
71-
ProtocolInformationAndHigher = 9
70+
ProtocolInformationAndHigher = 9,
7271
}
7372

7473
export enum MetaDataFields {
@@ -86,7 +85,7 @@ declare module "openzwave-shared" {
8685
Frequency = 11,
8786
Name = 12,
8887
Identifier = 13,
89-
Invalid = 255
88+
Invalid = 255,
9089
}
9190

9291
export interface DriverStats {
@@ -261,43 +260,43 @@ declare module "openzwave-shared" {
261260
/**
262261
* Should we refresh all UserCodes in the UserCode CC when we start up
263262
*/
264-
RefreshAllUserCodes: boolean;
265-
/**
266-
* Should we send the Node/Value Notifications on Driver Unloading - Read comments in Driver::~Driver() method about possible race conditions
267-
*/
268-
NotifyOnDriverUnload: boolean;
269-
/**
270-
* Alters how OZW determines when to Encrypt Messages to certain CommandClasses.
271-
* Options are:
272-
* "ESSENTIAL" - Those CommandClasses that MUST be encrypted.
273-
* "SUPPORTED" (default) is any CommandClass advertisied in the SecureNIF frame
274-
* "CUSTOM" - A list of CommandClasses specified in the "CustomSecureCC" option
275-
*/
276-
SecurityStrategy: 'ESSENTIAL' | 'SUPPORTED' | 'CUSTOM'
277-
/**
278-
* What List of Custom CC should we always encrypt if SecurityStrategy is CUSTOM
279-
*/
280-
CustomSecuredCC: string;
281-
/**
282-
* if we recieve a clear text message for a CC that is Secured, should we drop the message
283-
*/
284-
EnforceSecureReception: boolean;
285-
/**
286-
* if we should automatically update config files for devices if they are out of date
287-
*/
288-
AutoUpdateConfigFile: boolean;
289-
/**
290-
* Should we automatically Reload Nodes after a update
291-
*/
292-
ReloadAfterUpdate: 'AWAKE' | 'NEVER' | 'IMMEDIATE';
293-
/**
294-
* Language we should use
295-
*/
296-
Language: string;
297-
/**
298-
* Should we include the Instance Label in Value Labels on MultiInstance Devices
299-
*/
300-
IncludeInstanceLabel: boolean;
263+
RefreshAllUserCodes: boolean;
264+
/**
265+
* Should we send the Node/Value Notifications on Driver Unloading - Read comments in Driver::~Driver() method about possible race conditions
266+
*/
267+
NotifyOnDriverUnload: boolean;
268+
/**
269+
* Alters how OZW determines when to Encrypt Messages to certain CommandClasses.
270+
* Options are:
271+
* "ESSENTIAL" - Those CommandClasses that MUST be encrypted.
272+
* "SUPPORTED" (default) is any CommandClass advertisied in the SecureNIF frame
273+
* "CUSTOM" - A list of CommandClasses specified in the "CustomSecureCC" option
274+
*/
275+
SecurityStrategy: "ESSENTIAL" | "SUPPORTED" | "CUSTOM";
276+
/**
277+
* What List of Custom CC should we always encrypt if SecurityStrategy is CUSTOM
278+
*/
279+
CustomSecuredCC: string;
280+
/**
281+
* if we recieve a clear text message for a CC that is Secured, should we drop the message
282+
*/
283+
EnforceSecureReception: boolean;
284+
/**
285+
* if we should automatically update config files for devices if they are out of date
286+
*/
287+
AutoUpdateConfigFile: boolean;
288+
/**
289+
* Should we automatically Reload Nodes after a update
290+
*/
291+
ReloadAfterUpdate: "AWAKE" | "NEVER" | "IMMEDIATE";
292+
/**
293+
* Language we should use
294+
*/
295+
Language: string;
296+
/**
297+
* Should we include the Instance Label in Value Labels on MultiInstance Devices
298+
*/
299+
IncludeInstanceLabel: boolean;
301300
}
302301
}
303302

@@ -311,45 +310,29 @@ declare module "openzwave-shared" {
311310
on(event: "driver ready", listener: (homeId: number) => void): this;
312311
on(event: "driver failed", listener: () => void): this;
313312
on(
314-
event:
315-
| "polling enabled"
316-
| "polling disabled"
317-
| "node removed"
318-
| "node added",
319-
listener: (nodeId: number) => void
320-
): this;
321-
on(
322-
event: "node event",
323-
listener: (nodeId: number, data: any) => void
313+
event: "polling enabled" | "polling disabled" | "node removed" | "node added",
314+
listener: (nodeId: number) => void,
324315
): this;
316+
on(event: "node event", listener: (nodeId: number, data: any) => void): this;
325317
on(
326318
event: "node ready" | "node naming" | "node available",
327-
listener: (nodeId: number, nodeInfo: ZWave.NodeInfo) => void
328-
): this;
329-
on(
330-
event: "node reset",
331-
listener: (nodeid: number) => void
332-
): this;
333-
on(
334-
event: "user alert",
335-
listener: (notification: ZWave.Notification, help: string) => void
336-
): this;
337-
on(
338-
event: "manufacturer specific DB ready",
339-
listener: () => void
319+
listener: (nodeId: number, nodeInfo: ZWave.NodeInfo) => void,
340320
): this;
321+
on(event: "node reset", listener: (nodeid: number) => void): this;
322+
on(event: "user alert", listener: (notification: ZWave.Notification, help: string) => void): this;
323+
on(event: "manufacturer specific DB ready", listener: () => void): this;
341324
on(
342325
event: "value added" | "value changed" | "value refreshed",
343-
listener: (nodeId: number, comClass: number, value: ZWave.Value) => void
326+
listener: (nodeId: number, comClass: number, value: ZWave.Value) => void,
344327
): this;
345328
on(
346329
event: "value removed",
347-
listener: (nodeId: number, comClass: number, instance: number, index: number) => void
330+
listener: (nodeId: number, comClass: number, instance: number, index: number) => void,
348331
): this;
349332

350333
on(
351334
event: "notification",
352-
listener: (nodeId: number, notification: ZWave.Notification, help: string) => void
335+
listener: (nodeId: number, notification: ZWave.Notification, help: string) => void,
353336
): this;
354337
on(event: "scan complete", listener: () => void): this;
355338
on(
@@ -360,18 +343,13 @@ declare module "openzwave-shared" {
360343
notif: number,
361344
message: string,
362345
command: number,
363-
) => void
346+
) => void,
364347
): this;
365348
on(event: string, listener: (...args: any[]) => void): this;
366349

367350
// Exposed by "openzwave-config.cc"
368351

369-
setConfigParam(
370-
nodeId: number,
371-
param: number,
372-
value: number,
373-
size?: number
374-
): void;
352+
setConfigParam(nodeId: number, param: number, value: number, size?: number): void;
375353
requestConfigParam(nodeId: number, param: number): void;
376354
requestAllConfigParams(nodeId: number): void;
377355

@@ -472,16 +450,9 @@ declare module "openzwave-shared" {
472450

473451
addAssociation(nodeId: number, groupIdx: number, tgtNodeId: number): void;
474452

475-
removeAssociation(
476-
nodeId: number,
477-
groupIdx: number,
478-
tgtNodeId: number
479-
): void;
453+
removeAssociation(nodeId: number, groupIdx: number, tgtNodeId: number): void;
480454

481-
isMultiInstance(
482-
nodeId: number,
483-
groupIdx: number,
484-
): boolean;
455+
isMultiInstance(nodeId: number, groupIdx: number): boolean;
485456

486457
getAssociationsInstances(nodeId: number, groupIdx: number): Array<ZWave.InstanceAssociation>;
487458

@@ -747,7 +718,7 @@ declare module "openzwave-shared" {
747718
class_id: number,
748719
instance: number,
749720
index: number,
750-
value: string | boolean | number
721+
value: string | boolean | number,
751722
): void;
752723
setValue(valueId: ZWave.ValueId, value: string | boolean | number): void;
753724

@@ -760,13 +731,7 @@ declare module "openzwave-shared" {
760731
* Ask OZW to verify the value change before notifying the application.
761732
*/
762733
setChangeVerified(valueId: ZWave.ValueId, enabled: boolean): void;
763-
setChangeVerified(
764-
nodeid: number,
765-
class_id: number,
766-
instance: number,
767-
index: number,
768-
enabled: boolean
769-
): void;
734+
setChangeVerified(nodeid: number, class_id: number, instance: number, index: number, enabled: boolean): void;
770735
/**
771736
* Get number of thermostat switch points.
772737
*/
@@ -776,28 +741,15 @@ declare module "openzwave-shared" {
776741

777742
clearSwitchPoints(valueId: ZWave.ValueId): void;
778743

779-
removeSwitchPoint(
780-
valueId: ZWave.ValueId,
781-
switchPoint: ZWave.SwitchPoint
782-
): void;
744+
removeSwitchPoint(valueId: ZWave.ValueId, switchPoint: ZWave.SwitchPoint): void;
783745

784-
getValueAsBitSet(
785-
valueId: ZWave.ValueId,
786-
pos: number
787-
): number;
746+
getValueAsBitSet(valueId: ZWave.ValueId, pos: number): number;
788747

789-
setBitMask(
790-
valueId: ZWave.ValueId,
791-
mask: number
792-
): void;
748+
setBitMask(valueId: ZWave.ValueId, mask: number): void;
793749

794-
getBitMask(
795-
valueId: ZWave.ValueId
796-
): number;
750+
getBitMask(valueId: ZWave.ValueId): number;
797751

798-
getBitSetSize(
799-
valueId: ZWave.ValueId
800-
): number;
752+
getBitSetSize(valueId: ZWave.ValueId): number;
801753

802754
// Exposed by "openzwave-polling.cc"
803755

0 commit comments

Comments
 (0)