dphelper 1.9.4 → 1.9.14

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/CHANGELOG.md CHANGED
@@ -1,4 +1,4 @@
1
- ## Changelog
1
+ # Changelog
2
2
 
3
3
  ![dphelper](https://raw.githubusercontent.com/passariello/container/refs/heads/main/dphelper/assets/logos/logo.svg)
4
4
 
package/HISTORY.md CHANGED
@@ -0,0 +1 @@
1
+ none
@@ -1,17 +1,20 @@
1
1
  # Observer
2
2
 
3
3
  ## Overview
4
+
4
5
  This document provides a comprehensive list of all available observer functions in the `dphelper` library along with their descriptions and examples.
5
6
 
6
7
  ## Functions
7
8
 
8
9
  ### observer([state.name], [function])
10
+
9
11
  - **Description:** Sets up an observer to monitor state changes and trigger a callback.
10
12
  - **Parameters:**
11
13
  - `stateName` (string): The name of the state to monitor.
12
14
  - `callBack` (Function): The callback function to run when the state changes.
13
15
  - `option` (object): Additional options for the observer.
14
16
  - **Example:**
17
+
15
18
  ```javascript
16
19
  observer('state.test', (newValue) => {
17
20
  console.log('State changed:', newValue);
@@ -19,37 +22,46 @@ This document provides a comprehensive list of all available observer functions
19
22
  ```
20
23
 
21
24
  ### observer([state.name])
25
+
22
26
  - **Description:** Recall the observer previously generated.
23
27
  - **Returns:** Console log with a note
24
28
  - **Example:**
29
+
25
30
  ```javascript
26
31
  observer('state.test');
27
32
  ```
28
33
 
29
34
  ### observer.list
35
+
30
36
  - **Description:** See the list of all your observer (eventListener) actually installed.
31
37
  - **Returns:** The list of all installed observers.
32
38
  - **Example:**
39
+
33
40
  ```javascript
34
41
  observer.list;
35
42
  ```
36
43
 
37
44
  ### remove
45
+
38
46
  - **Description:** Remove an observer.
39
47
  - **Parameters:**
40
48
  - `name` (string): The name of the observer to remove.
41
49
  - **Example:**
50
+
42
51
  ```javascript
43
52
  observer.remove('state.test');
44
53
  ```
45
54
 
46
55
  ### removeAll
56
+
47
57
  - **Description:** Remove all observers.
48
58
  - **Returns:** void
49
59
  - **Example:**
60
+
50
61
  ```javascript
51
62
  observer.removeAll();
52
63
  ```
53
64
 
54
65
  ## License
66
+
55
67
  This project is licensed under the MIT License.
@@ -1,13 +1,16 @@
1
1
  # dpHelper State
2
2
 
3
3
  ## Overview
4
+
4
5
  This document provides a comprehensive list of all available state functions in the `dphelper` library along with their descriptions and examples.
5
6
 
6
7
  ## Functions
7
8
 
8
9
  ### state.[state.name] ex: _state.test_
10
+
9
11
  - **Description:** Set and get state values.
10
12
  - **Example:**
13
+
11
14
  ```javascript
12
15
  // To set a state value
13
16
  state.name = 'value';
@@ -17,26 +20,30 @@ This document provides a comprehensive list of all available state functions in
17
20
  ```
18
21
 
19
22
  ### state.list
23
+
20
24
  - **Description:** Show all states out of proxy.
21
25
  - **Example:**
26
+
22
27
  ```javascript
23
28
  state.list;
24
29
  ```
25
30
 
26
31
  ### state.remove([state.name])
32
+
27
33
  - **Description:** Remove a state.
28
34
  - **Parameters:**
29
35
  - `name` (string): The name of the state to remove.
30
36
  - **Example:**
37
+
31
38
  ```javascript
32
39
  state.remove('stateName');
33
40
  ```
34
41
 
35
42
  ### state.name.lock()
36
43
 
37
- >>> New option!
38
44
  - **Description:** Lock a state (only for types: Array, Object).
39
45
  - **Example:**
46
+
40
47
  ```javascript
41
48
  state.name = {test:"test"}
42
49
  state.name.lock();
@@ -45,9 +52,9 @@ This document provides a comprehensive list of all available state functions in
45
52
 
46
53
  ### state.removeAll()
47
54
 
48
- >>> New option!
49
55
  - **Description:** Remove all states.
50
56
  - **Example:**
57
+
51
58
  ```javascript
52
59
  state.name = {test:"test"}
53
60
  state.removeAll();
@@ -56,4 +63,5 @@ This document provides a comprehensive list of all available state functions in
56
63
  ```
57
64
 
58
65
  ## License
66
+
59
67
  This project is licensed under the MIT License.
@@ -1,64 +1,78 @@
1
1
  # dpHelper Store
2
2
 
3
3
  ## Overview
4
+
4
5
  This document provides a comprehensive list of all available store functions in the `dphelper` library along with their descriptions and examples.
5
6
 
6
7
  ## Functions
7
8
 
8
9
  ### store.get([store.name])
10
+
9
11
  - **Description:** Retrieve an item from local storage.
10
12
  - **Parameters:**
11
13
  - `name` (string): The name of the item to retrieve.
12
14
  - **Example:**
15
+
13
16
  ```javascript
14
17
  const value = store.get('itemName');
15
18
  console.log(value);
16
19
  ```
17
20
 
18
21
  ### store.set([name, value])
22
+
19
23
  - **Description:** Set an item in local storage.
20
24
  - **Parameters:**
21
25
  - `name` (string): The name of the item to set.
22
26
  - `value` (any): The value of the item to set.
23
27
  - **Example:**
28
+
24
29
  ```javascript
25
30
  store.set('itemName', value);
26
31
  ```
27
32
 
28
33
  ### store.remove([store.name])
34
+
29
35
  - **Description:** Delete an item from local storage.
30
36
  - **Parameters:**
31
37
  - `name` (string): The name of the item to delete.
32
38
  - **Example:**
39
+
33
40
  ```javascript
34
41
  store.remove('itemName');
35
42
  ```
36
43
 
37
44
  ### store.removeAll()
45
+
38
46
  - **Description:** Remove all items from local storage.
39
47
  - **Parameters:** None
40
48
  - **Example:**
49
+
41
50
  ```javascript
42
51
  store.removeAll();
43
52
  ```
44
53
 
45
54
  ### store.quota()
55
+
46
56
  - **Description:** Estimate the storage quota and usage.
47
57
  - **Parameters:** None
48
58
  - **Example:**
59
+
49
60
  ```javascript
50
61
  const quota = store.quota();
51
62
  console.log(quota);
52
63
  ```
53
64
 
54
65
  ### store.size()
66
+
55
67
  - **Description:** Calculate the total size of all items in local storage.
56
68
  - **Parameters:** None
57
69
  - **Example:**
70
+
58
71
  ```javascript
59
72
  const totalSize = store.size();
60
73
  console.log(totalSize);
61
74
  ```
62
75
 
63
76
  ## License
77
+
64
78
  This project is licensed under the MIT License.
@@ -1,15 +1,18 @@
1
1
  # All Functions List
2
2
 
3
3
  ## Overview
4
+
4
5
  This document provides a comprehensive list of all available functions in the `dphelper` library along with their descriptions.
5
6
 
6
7
  ## Functions
7
8
 
8
9
  ### Anchor
10
+
9
11
  - `dphelper.anchor.toOnClick(el)`
10
- <br> Converts an element's href attribute to an onclick event.
12
+ <br/> Converts an element's href attribute to an onclick event.
11
13
 
12
14
  ### Array
15
+
13
16
  - `dphelper.array.find(array, key)`
14
17
  <br> Finds an element in an array by key.
15
18
  - `dphelper.array.unique(array)`
@@ -58,14 +61,17 @@ This document provides a comprehensive list of all available functions in the `d
58
61
  <br> Generate a structured copy of an object.
59
62
 
60
63
  ### Audio
64
+
61
65
  - `dphelper.audio.play(url)`
62
66
  <br> Plays an audio file from a URL.
63
67
 
64
68
  ### Avoid
69
+
65
70
  - `dphelper.avoid.cache(uri)`
66
71
  <br> Caches a URI.
67
72
 
68
73
  ### Browser
74
+
69
75
  - `dphelper.browser.state(state, title, url)`
70
76
  <br> Changes the browser state.
71
77
  - `dphelper.browser.forw(times)`
@@ -84,6 +90,7 @@ This document provides a comprehensive list of all available functions in the `d
84
90
  <br> Gets the status text for a status code.
85
91
 
86
92
  ### Check
93
+
87
94
  - `dphelper.check.url(url)`
88
95
  <br> Checks if a URL is valid.
89
96
  - `dphelper.check.version(v1, v2, opts)`
@@ -92,6 +99,7 @@ This document provides a comprehensive list of all available functions in the `d
92
99
  <br> Gets the version of an npm package.
93
100
 
94
101
  ### Color
102
+
95
103
  - `dphelper.color.hex(c)`
96
104
  <br> Converts a color to hex format.
97
105
  - `dphelper.color.toHex(rgb)`
@@ -104,6 +112,7 @@ This document provides a comprehensive list of all available functions in the `d
104
112
  <br> Generates a gradient between two colors.
105
113
 
106
114
  ### Console
115
+
107
116
  - `dphelper.console.info(name, message, fn)`
108
117
  <br> Logs an info message to the console.
109
118
  - `dphelper.console.stop(options?[])`
@@ -112,6 +121,7 @@ This document provides a comprehensive list of all available functions in the `d
112
121
  <br> Converts console output to HTML.
113
122
 
114
123
  ### Cookie
124
+
115
125
  - `dphelper.cookie.set(params: { name, value, time?, path?: "/", sameSite?: "Lax", secure?: "Secure" | "false" })`
116
126
  <br> Sets a cookie.
117
127
  - `dphelper.cookie.get(name)`
@@ -122,6 +132,7 @@ This document provides a comprehensive list of all available functions in the `d
122
132
  <br> Clears all cookies.
123
133
 
124
134
  ### Coords
135
+
125
136
  - `dphelper.coods.degreesToRadians(degrees)`
126
137
  <br> Converts degrees to radians.
127
138
  - `dphelper.coods.latToMeters(points)`
@@ -138,6 +149,7 @@ This document provides a comprehensive list of all available functions in the `d
138
149
  <br> Maps degrees to pixels.
139
150
 
140
151
  ### Date
152
+
141
153
  - `dphelper.date.days(lang?)`
142
154
  <br> Returns the days of the week in a specified language.
143
155
  - `dphelper.date.months(lang?)`
@@ -188,6 +200,7 @@ This document provides a comprehensive list of all available functions in the `d
188
200
  <br> Returns a list of time zones.
189
201
 
190
202
  ### Disable
203
+
191
204
  - `dphelper.disable.select(el?)`
192
205
  <br> Disables text selection.
193
206
  - `dphelper.disable.spellCheck(tmr?)`
@@ -204,6 +217,7 @@ This document provides a comprehensive list of all available functions in the `d
204
217
  <br> Disables drag.
205
218
 
206
219
  ### Dispatch
220
+
207
221
  - `dphelper.dispatch.set(name, value?)`
208
222
  <br> Sets a dispatch event.
209
223
  - `dphelper.dispatch.listen(name, cb?, flag?)`
@@ -212,12 +226,14 @@ This document provides a comprehensive list of all available functions in the `d
212
226
  <br> Removes a dispatch event.
213
227
 
214
228
  ### Element
229
+
215
230
  - `dphelper.element.fitScale(el, scale?, fit?)`
216
231
  <br> Fits an element to a scale.
217
232
  - `dphelper.element.scaleBasedOnWindow(elm, scale, fit)`
218
233
  <br> Scales an element based on the window size.
219
234
 
220
235
  ### Events
236
+
221
237
  - `dphelper.events.list(el)`
222
238
  <br> Lists all events on an element.
223
239
  - `dphelper.events.multi(element, eventNames, listenerListener)`
@@ -230,6 +246,7 @@ This document provides a comprehensive list of all available functions in the `d
230
246
  <br> Gets the key, ctrl, alt, and shift status from a keyboard event.
231
247
 
232
248
  ### Form
249
+
233
250
  - `dphelper.form.serialize(form): { [key] }`
234
251
  <br> Serializes a form to an object.
235
252
  - `dphelper.form.confirmType(type, value)`
@@ -256,16 +273,19 @@ This document provides a comprehensive list of all available functions in the `d
256
273
  <br> Sanitizes a string.
257
274
 
258
275
  ### Format
276
+
259
277
  - `dphelper.format.currency(value, locale?, currency?)`
260
278
  <br> Formats a value as currency.
261
279
  - `dphelper.format.phoneNumber(value, countryCode?)`
262
280
  <br> Formats a phone number.
263
281
 
264
282
  ### Imports
283
+
265
284
  - `dphelper.imports.file(elem, file)`
266
285
  <br> Imports a file.
267
286
 
268
287
  ### Json
288
+
269
289
  - `dphelper.json.counter(json, key?, val?)`
270
290
  <br> Counts occurrences in a JSON object.
271
291
  - `dphelper.json.toCsv(jsonInput)`
@@ -282,6 +302,7 @@ This document provides a comprehensive list of all available functions in the `d
282
302
  <br> Sanitizes a JSON value.
283
303
 
284
304
  ### Load
305
+
285
306
  - `dphelper.load.all(context, cacheName?)`
286
307
  <br> Loads all modules in a context.
287
308
  - `dphelper.load.file(filePath)`
@@ -298,6 +319,7 @@ This document provides a comprehensive list of all available functions in the `d
298
319
  <br> Converts a context to JSON.
299
320
 
300
321
  ### Logging
322
+
301
323
  - `dphelper.logging.list: { type; message }`
302
324
  <br> List of log messages.
303
325
  - `dphelper.logging.reg(txt)`
@@ -308,6 +330,7 @@ This document provides a comprehensive list of all available functions in the `d
308
330
  <br> Logs an error message.
309
331
 
310
332
  ### Math
333
+
311
334
  - `dphelper.math.rnd()`
312
335
  <br> Generates a random number.
313
336
  - `dphelper.math.tmr()`
@@ -334,12 +357,14 @@ This document provides a comprehensive list of all available functions in the `d
334
357
  <br> Checks if a number is prime.
335
358
 
336
359
  ### Memory
360
+
337
361
  - `dphelper.memory.lock(obj)`
338
362
  <br> Locks an object in memory.
339
363
  - `dphelper.memory.unlock(obj)`
340
364
  <br> Unlocks an object in memory.
341
365
 
342
366
  ### Object
367
+
343
368
  - `dphelper.obj.toArray(object)`
344
369
  <br> Converts an object to an array.
345
370
  - `dphelper.obj.replaceNullObjects(data)`
@@ -374,6 +399,7 @@ This document provides a comprehensive list of all available functions in the `d
374
399
  <br> Generate a structured copy of an object.
375
400
 
376
401
  ### Path
402
+
377
403
  - `dphelper.path.rail()`
378
404
  <br> Returns the rail path.
379
405
  - `dphelper.path.hash()`
@@ -382,16 +408,19 @@ This document provides a comprehensive list of all available functions in the `d
382
408
  <br> Parses the query string of a URL.
383
409
 
384
410
  ### Promise
411
+
385
412
  - `dphelper.promise.check(p)`
386
413
  <br> Checks if a value is a promise.
387
414
  - `dphelper.promise.resolve(data)`
388
415
  <br> Resolves a promise with data.
389
416
 
390
417
  ### Sanitize
418
+
391
419
  - `dphelper.sanitize.html(s)`
392
420
  <br> Sanitizes HTML.
393
421
 
394
422
  ### Screen
423
+
395
424
  - `dphelper.screen.fullScreen(el)`
396
425
  <br> Enables full screen mode for an element.
397
426
  - `dphelper.screen.toggle(el)`
@@ -400,6 +429,7 @@ This document provides a comprehensive list of all available functions in the `d
400
429
  <br> Gets screen information.
401
430
 
402
431
  ### Scrollbar
432
+
403
433
  - `dphelper.scrollbar.custom(el, options)`
404
434
  <br> Customizes a scrollbar.
405
435
  - `dphelper.scrollbar.indicator(props)`
@@ -412,6 +442,7 @@ This document provides a comprehensive list of all available functions in the `d
412
442
  <br> Scrolls to an element within a container.
413
443
 
414
444
  ### Security
445
+
415
446
  - `dphelper.security.uuid: { byVal(string); v4; v5 }`
416
447
  <br> Generates UUIDs.
417
448
  - `dphelper.security.hashPass(u, p, t?)`
@@ -428,10 +459,12 @@ This document provides a comprehensive list of all available functions in the `d
428
459
  <br> Generates ULID (Universally Unique Lexicographically Sortable Identifier).
429
460
 
430
461
  ### Shortcut
462
+
431
463
  - `dphelper.shortcut.keys(e, trigger)`
432
464
  <br> Adds a keyboard shortcut.
433
465
 
434
466
  ### Socket
467
+
435
468
  - `dphelper.socket.info()`
436
469
  <br> Gets socket information.
437
470
  - `dphelper.socket.start(element, server)`
@@ -456,6 +489,7 @@ This document provides a comprehensive list of all available functions in the `d
456
489
  <br> Lists all socket connections.
457
490
 
458
491
  ### SVG
492
+
459
493
  - `dphelper.svg.init(container, source1, source2, cb?)`
460
494
  <br> Initializes an SVG container.
461
495
  - `dphelper.svg.check()`
@@ -480,14 +514,17 @@ This document provides a comprehensive list of all available functions in the `d
480
514
  <br> Converts an SVG element.
481
515
 
482
516
  ### System
517
+
483
518
  - `dphelper.svg.multiSplit()`
484
519
  <br> Splits a string into multiple parts.
485
520
 
486
521
  ### Terminal
522
+
487
523
  - `dphelper.terminal()`
488
524
  <br> Initializes a terminal.
489
525
 
490
526
  ### Text
527
+
491
528
  - `dphelper.text.trim(s, c, b, e)`
492
529
  <br> Trims a string.
493
530
  - `dphelper.text.capitalize(txt)`
@@ -506,12 +543,14 @@ This document provides a comprehensive list of all available functions in the `d
506
543
  <br> Fits a text element to its container.
507
544
 
508
545
  ### Timer
546
+
509
547
  - `dphelper.timer.sleep(ms)`
510
548
  <br> Pauses execution for a specified time.
511
549
  - `dphelper.timer.percentage(start, end)`
512
550
  <br> Calculates the percentage of time elapsed.
513
551
 
514
552
  ### Tools
553
+
515
554
  - `dphelper.dev.getip()`
516
555
  <br> Gets the IP address.
517
556
  - `dphelper.dev.byteSize(bytes)`
@@ -522,10 +561,12 @@ This document provides a comprehensive list of all available functions in the `d
522
561
  <br> Converts zero to false.
523
562
 
524
563
  ### Translators
564
+
525
565
  - `dphelper.translator.convertMatrixToScale(values)`
526
566
  <br> Converts a matrix to a scale.
527
567
 
528
568
  ### Trigger
569
+
529
570
  - `dphelper.trigger.click(elem)`
530
571
  <br> Triggers a click event.
531
572
  - `dphelper.trigger.change(elem)`
@@ -534,6 +575,7 @@ This document provides a comprehensive list of all available functions in the `d
534
575
  <br> Triggers an input event.
535
576
 
536
577
  ### Type
578
+
537
579
  - `dphelper.type.of(p)`
538
580
  <br> Gets the type of a value.
539
581
  - `dphelper.type.instOfObj(p)`
@@ -544,10 +586,12 @@ This document provides a comprehensive list of all available functions in the `d
544
586
  <br> Checks if a value is a boolean.
545
587
 
546
588
  ### UI
589
+
547
590
  - `dphelper.ui: null`
548
591
  <br> User interface operations.
549
592
 
550
593
  ### Window
594
+
551
595
  - `dphelper.window.enhancement()`
552
596
  <br> Enhances the window.
553
597
  - `dphelper.window.animationframe()`
@@ -566,4 +610,5 @@ This document provides a comprehensive list of all available functions in the `d
566
610
  <br> Gets the zoom level.
567
611
 
568
612
  ## License
613
+
569
614
  This project is licensed under the MIT License.
package/index.d.ts CHANGED
@@ -5,13 +5,16 @@
5
5
  https://dario.passariello.ca
6
6
  */
7
7
 
8
- /// <reference path="./types/dphelper.d.ts" />
8
+ // VENDORS
9
9
  /// <reference path="./types/jquery.d.ts" />
10
+ /// <reference path="./types/idb.d.ts" />
10
11
 
12
+ // BY DARIO PASSARIELLO
13
+ /// <reference path="./types/dphelper.d.ts" />
14
+ /// <reference path="./types/memorio.d.ts" />
11
15
  /// <reference path="./types/observer.d.ts" />
12
16
  /// <reference path="./types/state.d.ts" />
13
17
  /// <reference path="./types/store.d.ts" />
14
18
  /// <reference path="./types/cache.d.ts" />
15
- /// <reference path="./types/idb.d.ts" />
16
19
 
17
20