Skip to content

Commit e7c2fc8

Browse files
committed
JSDoc improvement
Signed-off-by: Florian Hotze <dev@florianhotze.com>
1 parent 14191ce commit e7c2fc8

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

src/rules/trigger-builder.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ class ChannelTriggerConfig extends TriggerConf {
190190
}
191191

192192
/**
193-
* channel trigger a specific event name
193+
* channel triggered a specific event name
194194
*
195195
* @param {string} eventName
196196
* @returns {ChannelTriggerConfig}

types/rules/trigger-builder.d.ts

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,21 @@ export type Item = {
22
rawItem: HostItem;
33
persistence: import("../items/item-persistence");
44
semantics: import("../items/item-semantics");
5-
readonly type: string; /** @private */
5+
readonly type: string;
6+
/** @private */
67
readonly groupType: string;
78
readonly name: string;
89
readonly label: string;
910
readonly state: string;
1011
readonly numericState: number;
1112
readonly quantityState: import("../quantity").Quantity;
1213
readonly boolState: boolean;
13-
readonly rawState: HostState;
14+
readonly rawState: HostState; /**
15+
* Item state changed from
16+
*
17+
* @param {string} value
18+
* @returns {ItemTriggerConfig}
19+
*/
1420
readonly previousState: string;
1521
readonly previousNumericState: number;
1622
readonly previousQuantityState: import("../quantity").Quantity;
@@ -117,7 +123,7 @@ export class ChannelTriggerConfig extends TriggerConf {
117123
/** @private */
118124
private describe;
119125
/**
120-
* channel trigger a specific event name
126+
* channel triggered a specific event name
121127
*
122128
* @param {string} eventName
123129
* @returns {ChannelTriggerConfig}

types/rules/trigger-builder.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)