tiny-essentials 1.22.2 โ 1.22.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/v1/TinyAdvancedRaffle.min.js +1 -1
- package/dist/v1/TinyDragger.min.js +1 -1
- package/dist/v1/TinyEssentials.min.js +1 -1
- package/dist/v1/TinyEvents.min.js +1 -1
- package/dist/v1/TinyHtml.min.js +1 -1
- package/dist/v1/TinyIframeEvents.min.js +1 -1
- package/dist/v1/TinyLocalStorage.min.js +1 -1
- package/dist/v1/TinyNewWinEvents.min.js +1 -1
- package/dist/v1/TinySmartScroller.min.js +1 -1
- package/dist/v1/TinyUploadClicker.min.js +1 -1
- package/dist/v1/libs/TinyAdvancedRaffle.cjs +13 -13
- package/dist/v1/libs/TinyAdvancedRaffle.d.mts +19 -19
- package/dist/v1/libs/TinyAdvancedRaffle.mjs +13 -13
- package/dist/v1/libs/TinyEvents.cjs +98 -73
- package/dist/v1/libs/TinyEvents.d.mts +22 -22
- package/dist/v1/libs/TinyEvents.mjs +103 -77
- package/dist/v1/libs/TinyHtml.cjs +69 -6
- package/dist/v1/libs/TinyHtml.d.mts +44 -6
- package/dist/v1/libs/TinyHtml.mjs +64 -6
- package/dist/v1/libs/TinyIframeEvents.cjs +11 -11
- package/dist/v1/libs/TinyIframeEvents.d.mts +19 -19
- package/dist/v1/libs/TinyIframeEvents.mjs +11 -11
- package/dist/v1/libs/TinyLocalStorage.cjs +12 -12
- package/dist/v1/libs/TinyLocalStorage.d.mts +21 -21
- package/dist/v1/libs/TinyLocalStorage.mjs +12 -12
- package/dist/v1/libs/TinyNewWinEvents.cjs +11 -11
- package/dist/v1/libs/TinyNewWinEvents.d.mts +19 -19
- package/dist/v1/libs/TinyNewWinEvents.mjs +11 -11
- package/dist/v1/libs/TinySmartScroller.cjs +12 -12
- package/dist/v1/libs/TinySmartScroller.d.mts +53 -30
- package/dist/v1/libs/TinySmartScroller.mjs +12 -12
- package/docs/v1/libs/TinyEvents.md +93 -105
- package/docs/v1/libs/TinyHtml.md +4 -2
- package/package.json +1 -1
|
@@ -1,199 +1,187 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ๐ข TinyEvents Documentation
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TinyEvents is a lightweight, dependency-free **event emitter system**, inspired by Node.jsโs `EventEmitter`.
|
|
4
|
+
It allows components to **subscribe**, **emit**, and **manage** events and their listeners in a clean and modular way.
|
|
4
5
|
|
|
5
6
|
---
|
|
6
7
|
|
|
7
|
-
##
|
|
8
|
+
## โจ Features
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* ๐ค Emitting events (`emit`)
|
|
16
|
-
* ๐ Inspecting listeners (`listenerCount`, `listeners`, `onceListeners`, `allListeners`, `eventNames`)
|
|
17
|
-
* ๐งน Removing listeners (`off`, `offAll`, `offAllTypes`)
|
|
18
|
-
* ๐ฆ Controlling listener count (`setMaxListeners`, `getMaxListeners`)
|
|
10
|
+
* โ Add/remove event listeners (`on`, `off`, `offAll`, `offAllTypes`)
|
|
11
|
+
* ๐ One-time listeners (`once`, `prependListenerOnce`)
|
|
12
|
+
* ๐ข Emit events (`emit`)
|
|
13
|
+
* ๐ Inspect listeners (`listenerCount`, `listeners`, `onceListeners`, `allListeners`, `eventNames`)
|
|
14
|
+
* โ๏ธ Control maximum listeners (`setMaxListeners`, `getMaxListeners`)
|
|
15
|
+
* ๐จ Configurable error/warning when max listeners exceeded (`setThrowOnMaxListeners`)
|
|
19
16
|
|
|
20
17
|
---
|
|
21
18
|
|
|
22
|
-
##
|
|
23
|
-
|
|
24
|
-
### `on(event: string, handler: function): void`
|
|
19
|
+
## ๐ API Reference
|
|
25
20
|
|
|
26
|
-
|
|
21
|
+
### ๐น Event Handler Callback
|
|
27
22
|
|
|
28
|
-
```
|
|
29
|
-
|
|
23
|
+
```ts
|
|
24
|
+
/**
|
|
25
|
+
* A generic event listener callback function.
|
|
26
|
+
*
|
|
27
|
+
* @callback handler
|
|
28
|
+
* @param {...any} payload - The data payload passed when the event is triggered.
|
|
29
|
+
* @returns {void}
|
|
30
|
+
*/
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
---
|
|
33
34
|
|
|
34
|
-
###
|
|
35
|
+
### ๐๏ธ Class: `TinyEvents`
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
#### ๐ Private Properties
|
|
37
38
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
* `#listeners: Map<string, { handler: handler, config: { once: boolean } }[]>` โ Stores registered listeners
|
|
40
|
+
* `#maxListeners: number` โ Maximum allowed listeners per event (default: `10`)
|
|
41
|
+
* `#throwMaxListeners: boolean` โ Whether to throw error or only warn when max is exceeded
|
|
41
42
|
|
|
42
43
|
---
|
|
43
44
|
|
|
44
|
-
###
|
|
45
|
+
### โ๏ธ Configuration
|
|
45
46
|
|
|
46
|
-
|
|
47
|
+
#### `setThrowOnMaxListeners(shouldThrow: boolean): void`
|
|
47
48
|
|
|
48
|
-
|
|
49
|
+
Enable/disable throwing an error when max listeners is exceeded.
|
|
49
50
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Alias for `once()`.
|
|
51
|
+
* โ
`true`: throws error
|
|
52
|
+
* โ ๏ธ `false`: logs warning
|
|
53
53
|
|
|
54
54
|
---
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
#### `getThrowOnMaxListeners(): boolean`
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
Check if exceeding the listener limit will throw an error or just warn.
|
|
59
59
|
|
|
60
60
|
---
|
|
61
61
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
Adds a one-time listener to the **start** of the listener array.
|
|
62
|
+
#### `setMaxListeners(n: number): void`
|
|
65
63
|
|
|
66
|
-
|
|
64
|
+
Set the maximum number of listeners per event.
|
|
67
65
|
|
|
68
|
-
|
|
66
|
+
* Must be a non-negative integer.
|
|
69
67
|
|
|
70
|
-
|
|
68
|
+
---
|
|
71
69
|
|
|
72
|
-
|
|
70
|
+
#### `getMaxListeners(): number`
|
|
73
71
|
|
|
74
|
-
|
|
75
|
-
emitter.emit('greet', 'Yasmin', 21);
|
|
76
|
-
```
|
|
72
|
+
Get the maximum number of listeners allowed per event.
|
|
77
73
|
|
|
78
74
|
---
|
|
79
75
|
|
|
80
|
-
###
|
|
81
|
-
|
|
82
|
-
Removes a specific listener from an event.
|
|
76
|
+
### โ Adding Listeners
|
|
83
77
|
|
|
84
|
-
|
|
78
|
+
#### `on(event: string|string[], handler: handler): void`
|
|
85
79
|
|
|
86
|
-
|
|
80
|
+
Registers an event listener.
|
|
87
81
|
|
|
88
|
-
|
|
82
|
+
#### `once(event: string|string[], handler: handler): handler[]`
|
|
89
83
|
|
|
90
|
-
|
|
84
|
+
Registers a one-time event listener that is removed after being triggered once.
|
|
91
85
|
|
|
92
|
-
|
|
86
|
+
#### `appendListener(event: string|string[], handler: handler): void`
|
|
93
87
|
|
|
94
|
-
|
|
88
|
+
Alias for `.on()`.
|
|
95
89
|
|
|
96
|
-
|
|
90
|
+
#### `appendListenerOnce(event: string|string[], handler: handler): handler[]`
|
|
97
91
|
|
|
98
|
-
|
|
92
|
+
Alias for `.once()`.
|
|
99
93
|
|
|
100
|
-
|
|
94
|
+
#### `prependListener(event: string|string[], handler: handler): void`
|
|
101
95
|
|
|
102
|
-
|
|
96
|
+
Registers a listener at the **beginning** of the listeners array.
|
|
103
97
|
|
|
104
|
-
|
|
98
|
+
#### `prependListenerOnce(event: string|string[], handler: handler): handler[]`
|
|
105
99
|
|
|
106
|
-
|
|
100
|
+
Registers a one-time listener at the **beginning** of the listeners array.
|
|
107
101
|
|
|
108
102
|
---
|
|
109
103
|
|
|
110
|
-
###
|
|
104
|
+
### โ Removing Listeners
|
|
111
105
|
|
|
112
|
-
|
|
106
|
+
#### `off(event: string|string[], handler: handler): void`
|
|
113
107
|
|
|
114
|
-
|
|
108
|
+
Removes a specific listener from an event.
|
|
115
109
|
|
|
116
|
-
|
|
110
|
+
#### `offAll(event: string|string[]): void`
|
|
117
111
|
|
|
118
|
-
|
|
112
|
+
Removes all listeners for one or more events.
|
|
119
113
|
|
|
120
|
-
|
|
114
|
+
#### `offAllTypes(): void`
|
|
121
115
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
Returns an array of event names that currently have listeners.
|
|
116
|
+
Removes **all listeners** for **all events**.
|
|
125
117
|
|
|
126
118
|
---
|
|
127
119
|
|
|
128
|
-
###
|
|
120
|
+
### ๐ข Emitting Events
|
|
129
121
|
|
|
130
|
-
|
|
122
|
+
#### `emit(event: string|string[], ...payload: any[]): boolean[]`
|
|
131
123
|
|
|
132
|
-
|
|
124
|
+
Emits one or more events with optional payload.
|
|
133
125
|
|
|
134
|
-
|
|
126
|
+
* Returns an array of booleans:
|
|
135
127
|
|
|
136
|
-
|
|
128
|
+
* `true` if listeners were called
|
|
129
|
+
* `false` if no listeners were registered
|
|
137
130
|
|
|
138
131
|
---
|
|
139
132
|
|
|
140
|
-
###
|
|
133
|
+
### ๐ Inspecting Listeners
|
|
141
134
|
|
|
142
|
-
|
|
135
|
+
#### `listenerCount(event: string): number`
|
|
143
136
|
|
|
144
|
-
|
|
145
|
-
* If `false`, it will default to console warning (default behavior).
|
|
137
|
+
Get the number of listeners for a given event.
|
|
146
138
|
|
|
147
|
-
####
|
|
139
|
+
#### `listeners(event: string): handler[]`
|
|
148
140
|
|
|
149
|
-
|
|
141
|
+
Get all listeners registered for an event (excluding `once`).
|
|
150
142
|
|
|
151
|
-
|
|
143
|
+
#### `onceListeners(event: string): handler[]`
|
|
144
|
+
|
|
145
|
+
Get only listeners registered with `.once()`.
|
|
152
146
|
|
|
153
|
-
|
|
147
|
+
#### `allListeners(event: string): handler[]`
|
|
154
148
|
|
|
155
|
-
|
|
149
|
+
Get all listeners, including internal wrappers (e.g. from `.once()`).
|
|
156
150
|
|
|
157
|
-
####
|
|
151
|
+
#### `eventNames(): string[]`
|
|
158
152
|
|
|
159
|
-
|
|
153
|
+
Get a list of all registered event names.
|
|
160
154
|
|
|
161
155
|
---
|
|
162
156
|
|
|
163
|
-
##
|
|
157
|
+
## ๐ Example Usage
|
|
164
158
|
|
|
165
159
|
```js
|
|
166
160
|
import TinyEvents from './TinyEvents.js';
|
|
167
161
|
|
|
168
|
-
const
|
|
162
|
+
const events = new TinyEvents();
|
|
169
163
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
}
|
|
164
|
+
// Add listener
|
|
165
|
+
events.on('data', (msg) => console.log('Received:', msg));
|
|
173
166
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
emitter.off('greet', greet);
|
|
177
|
-
```
|
|
167
|
+
// Add once listener
|
|
168
|
+
events.once(['ready', 'init'], () => console.log('Initialized!'));
|
|
178
169
|
|
|
179
|
-
|
|
170
|
+
// Emit events
|
|
171
|
+
events.emit('data', 'Hello World');
|
|
172
|
+
events.emit(['ready', 'init']);
|
|
180
173
|
|
|
181
|
-
|
|
174
|
+
// Check listeners
|
|
175
|
+
console.log(events.listenerCount('data')); // 1
|
|
182
176
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
* A generic event listener callback function.
|
|
186
|
-
* @callback handler
|
|
187
|
-
* @param {...any} payload - Arguments passed when event is emitted.
|
|
188
|
-
* @returns {void}
|
|
189
|
-
*/
|
|
177
|
+
// Remove all listeners
|
|
178
|
+
events.offAll('data');
|
|
190
179
|
```
|
|
191
180
|
|
|
192
181
|
---
|
|
193
182
|
|
|
194
|
-
##
|
|
183
|
+
## โก Notes
|
|
195
184
|
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
* Works in browser or Node
|
|
185
|
+
* Supports both **single string events** (`"data"`) and **arrays of events** (`["ready", "init"]`) ๐
|
|
186
|
+
* Helps prevent memory leaks with `setMaxListeners` and warning/error system ๐
|
|
187
|
+
* Perfect for **frontend components**, **Node.js scripts**, and **custom event-driven modules** ๐งฉ
|
package/docs/v1/libs/TinyHtml.md
CHANGED
|
@@ -935,7 +935,7 @@ Extracts a single DOM element from the internal list at the specified index.
|
|
|
935
935
|
|
|
936
936
|
---
|
|
937
937
|
|
|
938
|
-
### `
|
|
938
|
+
### `get elements`
|
|
939
939
|
Returns the current targets held by this instance.
|
|
940
940
|
|
|
941
941
|
- **Returns**: `ConstructorElValues[]`
|
|
@@ -2081,11 +2081,13 @@ Safe and type-checked โ throws if misuse is detected.
|
|
|
2081
2081
|
|
|
2082
2082
|
---
|
|
2083
2083
|
|
|
2084
|
-
### ๐งฒ `.hasProp()` / `.addProp()` / `.removeProp()` / `.toggleProp()`
|
|
2084
|
+
### ๐งฒ `.hasProp()` / `.addProp()` / `.removeProp()` / `.toggleProp()` / `.prop()` / `.setProp()`
|
|
2085
2085
|
|
|
2086
2086
|
Properties
|
|
2087
2087
|
|
|
2088
2088
|
```js
|
|
2089
|
+
element.prop('scrollHeight'); // get scrollHeight value
|
|
2090
|
+
element.setProp('disabled', true); // set true
|
|
2089
2091
|
element.hasProp("disabled"); // true/false
|
|
2090
2092
|
element.addProp("checked"); // set true
|
|
2091
2093
|
element.removeProp("checked"); // set false
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tiny-essentials",
|
|
3
|
-
"version": "1.22.
|
|
3
|
+
"version": "1.22.4",
|
|
4
4
|
"description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"test": "npm run test:mjs && npm run test:cjs && npm run test:js",
|