UNPKG

declarations

Version:

[![npm version](https://badge.fury.io/js/declarations.svg)](https://www.npmjs.com/package/declarations)

github.com/chbrown/declarations

chbrown/declarations

125 lines (123 loc) • 8.53 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// Type definitions for Apache Cordova BatteryStatus plugin. // Project: https://github.com/apache/cordova-plugin-battery-status // Definitions by: Microsoft Open Technologies, Inc. <http://msopentech.com> // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // // Copyright (c) Microsoft Open Technologies, Inc. // Licensed under the MIT license. interface Window { onbatterystatus: (type: BatteryStatusEvent) => void; onbatterycritical: (type: BatteryStatusEvent) => void; onbatterylow: (type: BatteryStatusEvent) => void; /** * Adds a listener for an event from the BatteryStatus plugin. * @param type the event to listen for * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param listener the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ addEventListener(type: "batterystatus", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Adds a listener for an event from the BatteryStatus plugin. * @param type the event to listen for * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param listener the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ addEventListener(type: "batterycritical", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Adds a listener for an event from the BatteryStatus plugin. * @param type the event to listen for * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param listener the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ addEventListener(type: "batterylow", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Adds a listener for an event from the BatteryStatus plugin. * @param type the event to listen for * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param listener the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ addEventListener(type: string, listener: (ev: Event) => any, useCapture?: boolean): void; /** * Removes a listener for an event from the BatteryStatus plugin. * @param type The event to stop listening for. * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param callback the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ removeEventListener(type: "batterystatus", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Removes a listener for an event from the BatteryStatus plugin. * @param type The event to stop listening for. * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param callback the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ removeEventListener(type: "batterycritical", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Removes a listener for an event from the BatteryStatus plugin. * @param type The event to stop listening for. * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param callback the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ removeEventListener(type: "batterylow", listener: (ev: BatteryStatusEvent) => any, useCapture?: boolean): void; /** * Removes a listener for an event from the BatteryStatus plugin. * @param type The event to stop listening for. * batterystatus: event fires when the percentage of battery charge * changes by at least 1 percent, or if the device is plugged in or unplugged. * batterycritical: event fires when the percentage of battery charge has reached * the critical battery threshold. The value is device-specific. * batterylow: event fires when the percentage of battery charge has * reached the low battery threshold, device-specific value. * @param callback the function that executes when the event fires. The function is * passed an BatteryStatusEvent object as a parameter. */ removeEventListener(type: string, listener: (ev: Event) => any, useCapture?: boolean): void; } /** Object, that passed into battery event listener */ interface BatteryStatusEvent extends Event { /* The percentage of battery charge (0-100). */ level: number; /* A boolean that indicates whether the device is plugged in. */ isPlugged: boolean; }