clientnode 3.0.838 → 3.0.842

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/index.d.ts CHANGED
@@ -10,7 +10,7 @@ export declare let globalContext: $Global;
10
10
  export declare const setGlobalContext: (context: $Global) => void;
11
11
  export declare const currentRequire: null | typeof require;
12
12
  export declare const currentImport: null | ImportFunction;
13
- export declare const optionalRequire: typeof require;
13
+ export declare const optionalRequire: <T = unknown>(id: string) => T | null;
14
14
  export declare const determine$: (() => $TStatic);
15
15
  export declare let $: $TStatic;
16
16
  /**
@@ -126,7 +126,6 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
126
126
  constructor($domNode?: $DomNode<TElement>, locks?: Mapping<Array<LockCallbackFunction<LockType>>>);
127
127
  /**
128
128
  * This method could be overwritten normally. It acts like a destructor.
129
- *
130
129
  * @returns Returns the current instance.
131
130
  */
132
131
  destructor(): Tools<TElement, LockType>;
@@ -140,6 +139,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
140
139
  initialize(options?: RecursivePartial<Options>): Promise<$DomNode<TElement>> | Promise<Tools> | Tools<TElement, LockType> | Tools;
141
140
  /**
142
141
  * Formats given date or current via given format specification.
142
+ * @param this - Indicates an unbound method.
143
143
  * @param format - Format specification.
144
144
  * @param dateTime - Date time to format.
145
145
  * @param options - Additional configuration options for
@@ -152,6 +152,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
152
152
  static dateTimeFormat(this: void, format?: string, dateTime?: Date, options?: SecondParameter<typeof Intl.DateTimeFormat>, locales?: Array<string> | string): string;
153
153
  /**
154
154
  * Defines a generic controller for dom node aware plugins.
155
+ * @param this - Indicates an unbound method.
155
156
  * @param object - The object or class to control. If "object" is a class
156
157
  * an instance will be generated.
157
158
  * @param parameters - The initially given arguments object.
@@ -186,6 +187,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
186
187
  releaseLock(description: string): Promise<LockType | void>;
187
188
  /**
188
189
  * Generate a semaphore object with given number of resources.
190
+ * @param this - Indicates an unbound method.
189
191
  * @param numberOfResources - Number of allowed concurrent resource uses.
190
192
  *
191
193
  * @returns The requested semaphore instance.
@@ -193,6 +195,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
193
195
  static getSemaphore(this: void, numberOfResources?: number): Semaphore;
194
196
  /**
195
197
  * Determines whether its argument represents a JavaScript number.
198
+ * @param this - Indicates an unbound method.
196
199
  * @param value - Value to analyze.
197
200
  *
198
201
  * @returns A boolean value indicating whether given object is numeric
@@ -201,6 +204,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
201
204
  static isNumeric(this: void, value: unknown): value is number;
202
205
  /**
203
206
  * Determine whether the argument is a window.
207
+ * @param this - Indicates an unbound method.
204
208
  * @param value - Value to check for.
205
209
  *
206
210
  * @returns Boolean value indicating the result.
@@ -209,6 +213,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
209
213
  /**
210
214
  * Checks if given object is similar to an array and can be handled like an
211
215
  * array.
216
+ * @param this - Indicates an unbound method.
212
217
  * @param object - Object to check behavior for.
213
218
  *
214
219
  * @returns A boolean value indicating whether given object is array like.
@@ -216,6 +221,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
216
221
  static isArrayLike(this: void, object: unknown): boolean;
217
222
  /**
218
223
  * Checks whether one of the given pattern matches given string.
224
+ * @param this - Indicates an unbound method.
219
225
  * @param target - Target to check in pattern for.
220
226
  * @param pattern - List of pattern to check for.
221
227
  *
@@ -225,14 +231,16 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
225
231
  static isAnyMatching(this: void, target: string, pattern: Array<string | RegExp>): boolean;
226
232
  /**
227
233
  * Checks whether given object is a native object but not null.
234
+ * @param this - Indicates an unbound method.
228
235
  * @param value - Value to check.
229
236
  *
230
237
  * @returns Value "true" if given object is a plain javaScript object and
231
238
  * "false" otherwise.
232
239
  */
233
- static isObject(this: void, value: unknown): value is object;
240
+ static isObject(this: void, value: unknown): value is Mapping<unknown>;
234
241
  /**
235
242
  * Checks whether given object is a plain native object.
243
+ * @param this - Indicates an unbound method.
236
244
  * @param value - Value to check.
237
245
  *
238
246
  * @returns Value "true" if given object is a plain javaScript object and
@@ -241,6 +249,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
241
249
  static isPlainObject(this: void, value: unknown): value is PlainObject;
242
250
  /**
243
251
  * Checks whether given object is a set.
252
+ * @param this - Indicates an unbound method.
244
253
  * @param value - Value to check.
245
254
  *
246
255
  * @returns Value "true" if given object is a set and "false" otherwise.
@@ -248,6 +257,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
248
257
  static isSet(this: void, value: unknown): value is Set<unknown>;
249
258
  /**
250
259
  * Checks whether given object is a map.
260
+ * @param this - Indicates an unbound method.
251
261
  * @param value - Value to check.
252
262
  *
253
263
  * @returns Value "true" if given object is a map and "false" otherwise.
@@ -255,6 +265,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
255
265
  static isMap(this: void, value: unknown): value is Map<unknown, unknown>;
256
266
  /**
257
267
  * Checks whether given object is a proxy.
268
+ * @param this - Indicates an unbound method.
258
269
  * @param value - Value to check.
259
270
  *
260
271
  * @returns Value "true" if given object is a proxy and "false" otherwise.
@@ -262,6 +273,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
262
273
  static isProxy(this: void, value: unknown): value is ProxyType;
263
274
  /**
264
275
  * Checks whether given object is a function.
276
+ * @param this - Indicates an unbound method.
265
277
  * @param value - Value to check.
266
278
  *
267
279
  * @returns Value "true" if given object is a function and "false"
@@ -336,6 +348,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
336
348
  warn(object: unknown, ...additionalArguments: Array<unknown>): void;
337
349
  /**
338
350
  * Dumps a given object in a human readable format.
351
+ * @param this - Indicates an unbound method.
339
352
  * @param object - Any object to show.
340
353
  * @param level - Number of levels to dig into given object recursively.
341
354
  * @param currentLevel - Maximal number of recursive function calls to
@@ -346,6 +359,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
346
359
  static show(this: void, object: unknown, level?: number, currentLevel?: number): string;
347
360
  /**
348
361
  * Deletes a cookie value by given name.
362
+ * @param this - Indicates an unbound method.
349
363
  * @param name - Name to identify requested value.
350
364
  *
351
365
  * @returns Nothing.
@@ -353,6 +367,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
353
367
  static deleteCookie(this: void, name: string): void;
354
368
  /**
355
369
  * Gets a cookie value by given name.
370
+ * @param this - Indicates an unbound method.
356
371
  * @param name - Name to identify requested value.
357
372
  *
358
373
  * @returns Requested value.
@@ -360,6 +375,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
360
375
  static getCookie(this: void, name: string): string | null;
361
376
  /**
362
377
  * Sets a cookie key-value-pair.
378
+ * @param this - Indicates an unbound method.
363
379
  * @param name - Name to identify given value.
364
380
  * @param value - Value to set.
365
381
  * @param domain - Domain to reference with given key-value-pair.
@@ -377,7 +393,6 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
377
393
  static setCookie(this: void, name: string, value: string, domain?: string, sameSite?: 'Lax' | 'None' | 'Strict' | '', numberOfDaysUntilExpiration?: number, path?: string, secure?: boolean, httpOnly?: boolean): boolean;
378
394
  /**
379
395
  * Normalizes class name order of current dom node.
380
- *
381
396
  * @returns Current instance.
382
397
  */
383
398
  get normalizedClassNames(): Tools<TElement, LockType>;
@@ -399,6 +414,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
399
414
  get text(): string;
400
415
  /**
401
416
  * Checks whether given html or text strings are equal.
417
+ * @param this - Indicates an unbound method.
402
418
  * @param first - First html, selector to dom node or text to compare.
403
419
  * @param second - Second html, selector to dom node or text to compare.
404
420
  * @param forceHTMLString - Indicates whether given contents are
@@ -413,6 +429,10 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
413
429
  * position.
414
430
  * @param givenDelta - Allows deltas for "top", "left", "bottom" and
415
431
  * "right" for determining positions.
432
+ * @param givenDelta.bottom - Bottom delta.
433
+ * @param givenDelta.left - Left delta.
434
+ * @param givenDelta.right - Right delta.
435
+ * @param givenDelta.top - Top delta.
416
436
  *
417
437
  * @returns Returns one of "above", "left", "below", "right" or "in".
418
438
  */
@@ -424,6 +444,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
424
444
  }): RelativePosition;
425
445
  /**
426
446
  * Generates a directive name corresponding selector string.
447
+ * @param this - Indicates an unbound method.
427
448
  * @param directiveName - The directive name.
428
449
  *
429
450
  * @returns Returns generated selector.
@@ -443,6 +464,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
443
464
  renderJavaScriptDependentVisibility(): void;
444
465
  /**
445
466
  * Determines a normalized camel case directive name representation.
467
+ * @param this - Indicates an unbound method.
446
468
  * @param directiveName - The directive name.
447
469
  *
448
470
  * @returns Returns the corresponding name.
@@ -465,6 +487,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
465
487
  sliceDomNodeSelectorPrefix(domNodeSelector: string): string;
466
488
  /**
467
489
  * Determines the dom node name of a given dom node string.
490
+ * @param this - Indicates an unbound method.
468
491
  * @param domNodeSelector - A given to dom node selector to determine its
469
492
  * name.
470
493
  *
@@ -494,15 +517,17 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
494
517
  grabDomNodes(domNodeSelectors: Mapping, wrapperDomNode?: Node | null | string | $DomNode<Node>): $DomNodes;
495
518
  /**
496
519
  * Overwrites all inherited variables from parent scope with "undefined".
520
+ * @param this - Indicates an unbound method.
497
521
  * @param scope - A scope where inherited names will be removed.
498
522
  * @param prefixesToIgnore - Name prefixes to ignore during deleting names
499
523
  * in given scope.
500
524
  *
501
525
  * @returns The isolated scope.
502
526
  */
503
- static isolateScope<T extends Object>(this: void, scope: T, prefixesToIgnore?: Array<string>): T;
527
+ static isolateScope<T extends Mapping<unknown>>(this: void, scope: T, prefixesToIgnore?: Array<string>): T;
504
528
  /**
505
529
  * Generates a unique name in given scope (useful for jsonp requests).
530
+ * @param this - Indicates an unbound method.
506
531
  * @param prefix - A prefix which will be prepended to unique name.
507
532
  * @param suffix - A suffix which will be prepended to unique name.
508
533
  * @param scope - A scope where the name should be unique.
@@ -510,10 +535,11 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
510
535
  *
511
536
  * @returns The function name.
512
537
  */
513
- static determineUniqueScopeName(this: void, prefix?: string, suffix?: string, scope?: object, initialUniqueName?: string): string;
538
+ static determineUniqueScopeName(this: void, prefix?: string, suffix?: string, scope?: Mapping<unknown>, initialUniqueName?: string): string;
514
539
  /**
515
540
  * Determines all parameter names from given callable (function or class,
516
541
  * ...).
542
+ * @param this - Indicates an unbound method.
517
543
  * @param callable - Function or function code to inspect.
518
544
  *
519
545
  * @returns List of parameter names.
@@ -521,6 +547,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
521
547
  static getParameterNames(this: void, callable: AnyFunction | string): Array<string>;
522
548
  /**
523
549
  * Implements the identity function.
550
+ * @param this - Indicates an unbound method.
524
551
  * @param value - A value to return.
525
552
  *
526
553
  * @returns Returns the given value.
@@ -528,15 +555,17 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
528
555
  static identity<T>(this: void, value: T): T;
529
556
  /**
530
557
  * Inverted filter helper to inverse each given filter.
558
+ * @param this - Indicates an unbound method.
531
559
  * @param filter - A function that filters an array.
532
560
  *
533
561
  * @returns The inverted filter.
534
562
  */
535
- static invertArrayFilter<T extends AnyFunction = (this: void, data: Array<unknown>, ...additionalParameter: Array<unknown>) => Array<unknown>>(filter: T): T;
563
+ static invertArrayFilter<T extends AnyFunction = (_data: Array<unknown>, ..._additionalParameter: Array<unknown>) => Array<unknown>>(this: void, filter: T): T;
536
564
  /**
537
565
  * Triggers given callback after given duration. Supports unlimited
538
566
  * duration length and returns a promise which will be resolved after given
539
567
  * duration has been passed.
568
+ * @param this - Indicates an unbound method.
540
569
  * @param parameters - Observes the first three existing parameters. If one
541
570
  * is a number it will be interpret as delay in milliseconds until given
542
571
  * callback will be triggered. If one is of type function it will be used
@@ -555,6 +584,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
555
584
  * Prevents event functions from triggering to often by defining a minimal
556
585
  * span between each function call. Additional arguments given to this
557
586
  * function will be forwarded to given event function call.
587
+ * @param this - Indicates an unbound method.
558
588
  * @param callback - The function to call debounced.
559
589
  * @param thresholdInMilliseconds - The minimum time span between each
560
590
  * function call.
@@ -563,7 +593,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
563
593
  *
564
594
  * @returns Returns the wrapped method.
565
595
  */
566
- static debounce<T = unknown>(this: void, callback: AnyFunction, thresholdInMilliseconds?: number, ...additionalArguments: Array<unknown>): ((...parameters: Array<unknown>) => Promise<T>);
596
+ static debounce<T = unknown>(this: void, callback: AnyFunction, thresholdInMilliseconds?: number, ...additionalArguments: Array<unknown>): ((..._parameters: Array<unknown>) => Promise<T>);
567
597
  /**
568
598
  * Searches for internal event handler methods and runs them by default. In
569
599
  * addition this method searches for a given event method by the options
@@ -601,6 +631,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
601
631
  off<TElement = HTMLElement>(...parameters: Array<unknown>): $DomNode<TElement>;
602
632
  /**
603
633
  * Adds dynamic getter and setter to any given data structure such as maps.
634
+ * @param this - Indicates an unbound method.
604
635
  * @param object - Object to proxy.
605
636
  * @param getterWrapper - Function to wrap each property get.
606
637
  * @param setterWrapper - Function to wrap each property set.
@@ -620,17 +651,19 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
620
651
  * This method traverses given object recursively and tracks of seen and
621
652
  * already serialized structures to reuse generated strings or mark a
622
653
  * circular reference.
654
+ * @param this - Indicates an unbound method.
623
655
  * @param object - Object to serialize.
624
- * @param determineCicularReferenceValue - Callback to create a fallback
656
+ * @param determineCircularReferenceValue - Callback to create a fallback
625
657
  * value depending on given redundant value.
626
658
  * @param numberOfSpaces - Number of spaces to use for string formatting.
627
659
  *
628
660
  * @returns The formatted json string.
629
661
  */
630
- static convertCircularObjectToJSON(this: void, object: unknown, determineCircularReferenceValue?: ((serializedValue: null | unknown, key: null | string, value: unknown, seenObjects: Map<unknown, null | unknown>) => unknown), numberOfSpaces?: number): ReturnType<typeof JSON.stringify> | undefined;
662
+ static convertCircularObjectToJSON(this: void, object: unknown, determineCircularReferenceValue?: ((_serializedValue: null | unknown, _key: null | string, _value: unknown, _seenObjects: Map<unknown, null | unknown>) => unknown), numberOfSpaces?: number): ReturnType<typeof JSON.stringify> | undefined;
631
663
  /**
632
664
  * Converts given map and all nested found maps objects to corresponding
633
665
  * object.
666
+ * @param this - Indicates an unbound method.
634
667
  * @param object - Map to convert to.
635
668
  * @param deep - Indicates whether to perform a recursive conversion.
636
669
  *
@@ -640,6 +673,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
640
673
  /**
641
674
  * Converts given plain object and all nested found objects to
642
675
  * corresponding map.
676
+ * @param this - Indicates an unbound method.
643
677
  * @param object - Object to convert to.
644
678
  * @param deep - Indicates whether to perform a recursive conversion.
645
679
  *
@@ -649,15 +683,17 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
649
683
  /**
650
684
  * Replaces given pattern in each value in given object recursively with
651
685
  * given string replacement.
686
+ * @param this - Indicates an unbound method.
652
687
  * @param object - Object to convert substrings in.
653
688
  * @param pattern - Regular expression to replace.
654
689
  * @param replacement - String to use as replacement for found patterns.
655
690
  *
656
691
  * @returns Converted object with replaced patterns.
657
692
  */
658
- static convertSubstringInPlainObject<Type extends object = PlainObject>(this: void, object: Type, pattern: RegExp | string, replacement: string): Type;
693
+ static convertSubstringInPlainObject<Type extends Mapping<unknown> = PlainObject>(this: void, object: Type, pattern: RegExp | string, replacement: string): Type;
659
694
  /**
660
695
  * Copies given object (of any type) into optionally given destination.
696
+ * @param this - Indicates an unbound method.
661
697
  * @param source - Object to copy.
662
698
  * @param recursionLimit - Specifies how deep we should traverse into given
663
699
  * object recursively.
@@ -677,6 +713,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
677
713
  static copy<Type = unknown>(this: void, source: Type, recursionLimit?: number, recursionEndValue?: unknown, destination?: null | Type, cyclic?: boolean, knownReferences?: Array<unknown>, recursionLevel?: number): Type;
678
714
  /**
679
715
  * Determine the internal JavaScript [[Class]] of an object.
716
+ * @param this - Indicates an unbound method.
680
717
  * @param value - Value to analyze.
681
718
  *
682
719
  * @returns Name of determined type.
@@ -686,6 +723,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
686
723
  * Returns true if given items are equal for given property list. If
687
724
  * property list isn't set all properties will be checked. All keys which
688
725
  * starts with one of the exception prefixes will be omitted.
726
+ * @param this - Indicates an unbound method.
689
727
  * @param firstValue - First object to compare.
690
728
  * @param secondValue - Second object to compare.
691
729
  *
@@ -714,6 +752,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
714
752
  * Searches for nested mappings with given indicator key and resolves
715
753
  * marked values. Additionally all objects are wrapped with a proxy to
716
754
  * dynamically resolve nested properties.
755
+ * @param this - Indicates an unbound method.
717
756
  * @param object - Given mapping to resolve.
718
757
  * @param scope - Scope to to use evaluate again.
719
758
  * @param selfReferenceName - Name to use for reference to given object.
@@ -727,6 +766,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
727
766
  static evaluateDynamicData<Type = unknown>(this: void, object: null | RecursiveEvaluateable<Type>, scope?: Mapping<unknown>, selfReferenceName?: string, expressionIndicatorKey?: string, executionIndicatorKey?: string): Type;
728
767
  /**
729
768
  * Removes properties in objects where a dynamic indicator lives.
769
+ * @param this - Indicates an unbound method.
730
770
  * @param data - Object to traverse recursively.
731
771
  * @param expressionIndicators - Property key to remove.
732
772
  *
@@ -737,6 +777,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
737
777
  * Extends given target object with given sources object. As target and
738
778
  * sources many expandable types are allowed but target and sources have to
739
779
  * to come from the same type.
780
+ * @param this - Indicates an unbound method.
740
781
  * @param targetOrDeepIndicator - Maybe the target or deep indicator.
741
782
  * @param targetOrSource - Target or source object; depending on first
742
783
  * argument.
@@ -744,10 +785,11 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
744
785
  *
745
786
  * @returns Returns given target extended with all given sources.
746
787
  */
747
- static extend<T = Mapping<unknown>>(this: void, targetOrDeepIndicator: boolean | typeof IgnoreNullAndUndefinedSymbol | RecursivePartial<T>, targetOrSource?: RecursivePartial<T>, ...additionalSources: Array<RecursivePartial<T>>): T;
788
+ static extend<T = Mapping<unknown>>(this: void, targetOrDeepIndicator: (boolean | typeof IgnoreNullAndUndefinedSymbol | RecursivePartial<T>), targetOrSource?: RecursivePartial<T>, ...additionalSources: Array<RecursivePartial<T>>): T;
748
789
  /**
749
790
  * Retrieves substructure in given object referenced by given selector
750
791
  * path.
792
+ * @param this - Indicates an unbound method.
751
793
  * @param target - Object to search in.
752
794
  * @param selector - Selector path.
753
795
  * @param skipMissingLevel - Indicates to skip missing level in given path.
@@ -759,6 +801,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
759
801
  /**
760
802
  * Generates a proxy handler which forwards all operations to given object
761
803
  * as there wouldn't be a proxy.
804
+ * @param this - Indicates an unbound method.
762
805
  * @param target - Object to proxy.
763
806
  * @param methodNames - Mapping of operand name to object specific method
764
807
  * name.
@@ -770,16 +813,18 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
770
813
  * Slices all properties from given object which does not match provided
771
814
  * object mask. Items can be explicitly white listed via "include" mask
772
815
  * configuration or black listed via "exclude" mask configuration.
816
+ * @param this - Indicates an unbound method.
773
817
  * @param object - Object to slice.
774
818
  * @param mask - Mask configuration.
775
819
  *
776
820
  * @returns Given but sliced object. If (nested) object will be modified a
777
821
  * flat copy of that object will be returned.
778
822
  */
779
- static mask<Type = object>(this: void, object: Type, mask: ObjectMaskConfiguration): RecursivePartial<Type>;
823
+ static mask<Type = Mapping<unknown>>(this: void, object: Type, mask: ObjectMaskConfiguration): RecursivePartial<Type>;
780
824
  /**
781
825
  * Modifies given target corresponding to given source and removes source
782
826
  * modification infos.
827
+ * @param this - Indicates an unbound method.
783
828
  * @param target - Object to modify.
784
829
  * @param source - Source object to load modifications from.
785
830
  * @param removeIndicatorKey - Indicator property name or value to mark a
@@ -802,6 +847,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
802
847
  static modifyObject<T = unknown>(this: void, target: T, source: unknown, removeIndicatorKey?: string, prependIndicatorKey?: string, appendIndicatorKey?: string, positionPrefix?: string, positionSuffix?: string, parentSource?: unknown, parentKey?: unknown): T | null;
803
848
  /**
804
849
  * Interprets a date object from given artefact.
850
+ * @param this - Indicates an unbound method.
805
851
  * @param value - To interpret.
806
852
  * @param interpretAsUTC - Identifies if given date should be interpret as
807
853
  * utc.
@@ -812,6 +858,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
812
858
  static normalizeDateTime(this: void, value?: string | null | number | Date, interpretAsUTC?: boolean): Date | null;
813
859
  /**
814
860
  * Removes given key from given object recursively.
861
+ * @param this - Indicates an unbound method.
815
862
  * @param object - Object to process.
816
863
  * @param keys - List of keys to remove.
817
864
  *
@@ -820,6 +867,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
820
867
  static removeKeyPrefixes<T>(this: void, object: T, keys?: Array<string> | string): T;
821
868
  /**
822
869
  * Represents given object as formatted string.
870
+ * @param this - Indicates an unbound method.
823
871
  * @param object - Object to represent.
824
872
  * @param indention - String (usually whitespaces) to use as indention.
825
873
  * @param initialIndention - String (usually whitespaces) to use as
@@ -834,6 +882,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
834
882
  static represent(this: void, object: unknown, indention?: string, initialIndention?: string, maximumNumberOfLevelsReachedIdentifier?: number | string, numberOfLevels?: number): string;
835
883
  /**
836
884
  * Sort given objects keys.
885
+ * @param this - Indicates an unbound method.
837
886
  * @param object - Object which keys should be sorted.
838
887
  *
839
888
  * @returns Sorted list of given keys.
@@ -841,6 +890,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
841
890
  static sort(this: void, object: unknown): Array<unknown>;
842
891
  /**
843
892
  * Removes a proxy from given data structure recursively.
893
+ * @param this - Indicates an unbound method.
844
894
  * @param object - Object to proxy.
845
895
  * @param seenObjects - Tracks all already processed objects to avoid
846
896
  * endless loops (usually only needed for internal purpose).
@@ -850,6 +900,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
850
900
  static unwrapProxy<T = unknown>(this: void, object: T, seenObjects?: Set<unknown>): T;
851
901
  /**
852
902
  * Summarizes given property of given item list.
903
+ * @param this - Indicates an unbound method.
853
904
  * @param data - Array of objects with given property name.
854
905
  * @param propertyName - Property name to summarize.
855
906
  * @param defaultValue - Value to return if property values doesn't match.
@@ -862,6 +913,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
862
913
  * names. If given property names are empty each attribute will be
863
914
  * considered. The empty string, "null" and "undefined" will be interpreted
864
915
  * as empty.
916
+ * @param this - Indicates an unbound method.
865
917
  * @param data - Data to filter.
866
918
  * @param propertyNames - Properties to consider.
867
919
  *
@@ -871,6 +923,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
871
923
  /**
872
924
  * Extracts all properties from all items wich occur in given property
873
925
  * names.
926
+ * @param this - Indicates an unbound method.
874
927
  * @param data - Data where each item should be sliced.
875
928
  * @param propertyNames - Property names to extract.
876
929
  *
@@ -879,6 +932,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
879
932
  static arrayExtract<T = Mapping<unknown>>(this: void, data: unknown, propertyNames: Array<string>): Array<T>;
880
933
  /**
881
934
  * Extracts all values which matches given regular expression.
935
+ * @param this - Indicates an unbound method.
882
936
  * @param data - Data to filter.
883
937
  * @param regularExpression - Pattern to match for.
884
938
  *
@@ -887,6 +941,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
887
941
  static arrayExtractIfMatches(this: void, data: unknown, regularExpression: string | RegExp): Array<string>;
888
942
  /**
889
943
  * Filters given data if given property is set or not.
944
+ * @param this - Indicates an unbound method.
890
945
  * @param data - Data to filter.
891
946
  * @param propertyName - Property name to check for existence.
892
947
  *
@@ -897,6 +952,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
897
952
  /**
898
953
  * Extract given data where specified property value matches given
899
954
  * patterns.
955
+ * @param this - Indicates an unbound method.
900
956
  * @param data - Data to filter.
901
957
  * @param propertyPattern - Mapping of property names to pattern.
902
958
  *
@@ -908,6 +964,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
908
964
  * Object key which will be compared are given by "keys". If an empty array
909
965
  * is given each key will be compared. If an object is given corresponding
910
966
  * initial data key will be mapped to referenced new data key.
967
+ * @param this - Indicates an unbound method.
911
968
  * @param first - Referenced data to check for.
912
969
  * @param second - Data to check for existence.
913
970
  * @param keys - Keys to define equality.
@@ -920,6 +977,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
920
977
  static arrayIntersect<T = unknown>(this: void, first: unknown, second: unknown, keys?: Array<string> | Mapping<number | string>, strict?: boolean): Array<T>;
921
978
  /**
922
979
  * Converts given object into an array.
980
+ * @param this - Indicates an unbound method.
923
981
  * @param object - Target to convert.
924
982
  *
925
983
  * @returns Generated array.
@@ -927,6 +985,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
927
985
  static arrayMake<T = unknown>(this: void, object: unknown): Array<T>;
928
986
  /**
929
987
  * Creates a list of items within given range.
988
+ * @param this - Indicates an unbound method.
930
989
  * @param range - Array of lower and upper bounds. If only one value is
931
990
  * given lower bound will be assumed to be zero. Both integers have to be
932
991
  * positive and will be contained in the resulting array. If more than two
@@ -939,6 +998,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
939
998
  static arrayMakeRange(this: void, range: number | [number] | [number, number] | Array<number>, step?: number, ignoreLastStep?: boolean): Array<number>;
940
999
  /**
941
1000
  * Merge the contents of two arrays together into the first array.
1001
+ * @param this - Indicates an unbound method.
942
1002
  * @param target - Target array.
943
1003
  * @param source - Source array.
944
1004
  *
@@ -947,6 +1007,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
947
1007
  static arrayMerge<T = unknown>(this: void, target: Array<T>, source: Array<T>): Array<T>;
948
1008
  /**
949
1009
  * Generates a list if pagination symbols to render a pagination from.
1010
+ * @param this - Indicates an unbound method.
950
1011
  * @param options - Configure bounds and current page of pagination to
951
1012
  * determine.
952
1013
  * @param options.boundaryCount - Indicates where to start pagination
@@ -971,6 +1032,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
971
1032
  static arrayPaginate(this: void, options?: Partial<PaginateOptions>): Array<Page>;
972
1033
  /**
973
1034
  * Generates all permutations of given iterable.
1035
+ * @param this - Indicates an unbound method.
974
1036
  * @param data - Array like object.
975
1037
  *
976
1038
  * @returns Array of permuted arrays.
@@ -978,6 +1040,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
978
1040
  static arrayPermutate<T = unknown>(this: void, data: Array<T>): Array<Array<T>>;
979
1041
  /**
980
1042
  * Generates all lengths permutations of given iterable.
1043
+ * @param this - Indicates an unbound method.
981
1044
  * @param data - Array like object.
982
1045
  * @param minimalSubsetLength - Defines how long the minimal subset length
983
1046
  * should be.
@@ -987,6 +1050,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
987
1050
  static arrayPermutateLength<T = unknown>(this: void, data: Array<T>, minimalSubsetLength?: number): Array<Array<T>>;
988
1051
  /**
989
1052
  * Sums up given property of given item list.
1053
+ * @param this - Indicates an unbound method.
990
1054
  * @param data - The objects with specified property to sum up.
991
1055
  * @param propertyName - Property name to sum up its value.
992
1056
  *
@@ -995,6 +1059,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
995
1059
  static arraySumUpProperty(this: void, data: unknown, propertyName: string): number;
996
1060
  /**
997
1061
  * Adds an item to another item as array connection (many to one).
1062
+ * @param this - Indicates an unbound method.
998
1063
  * @param item - Item where the item should be appended to.
999
1064
  * @param target - Target to add to given item.
1000
1065
  * @param name - Name of the target connection.
@@ -1006,6 +1071,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1006
1071
  static arrayAppendAdd<T = unknown>(this: void, item: Mapping<T>, target: unknown, name: string, checkIfExists?: boolean): Mapping<T>;
1007
1072
  /**
1008
1073
  * Removes given target on given list.
1074
+ * @param this - Indicates an unbound method.
1009
1075
  * @param list - Array to splice.
1010
1076
  * @param target - Target to remove from given list.
1011
1077
  * @param strict - Indicates whether to fire an exception if given target
@@ -1016,6 +1082,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1016
1082
  static arrayRemove<T = unknown>(this: void, list: Array<T>, target: T, strict?: boolean): Array<T>;
1017
1083
  /**
1018
1084
  * Sorts given object of dependencies in a topological order.
1085
+ * @param this - Indicates an unbound method.
1019
1086
  * @param items - Items to sort.
1020
1087
  *
1021
1088
  * @returns Sorted array of given items respecting their dependencies.
@@ -1024,6 +1091,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1024
1091
  /**
1025
1092
  * Makes all values in given iterable unique by removing duplicates (The
1026
1093
  * first occurrences will be left).
1094
+ * @param this - Indicates an unbound method.
1027
1095
  * @param data - Array like object.
1028
1096
  *
1029
1097
  * @returns Sliced version of given object.
@@ -1032,6 +1100,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1032
1100
  /**
1033
1101
  * Translates given string into the regular expression validated
1034
1102
  * representation.
1103
+ * @param this - Indicates an unbound method.
1035
1104
  * @param value - String to convert.
1036
1105
  * @param excludeSymbols - Symbols not to escape.
1037
1106
  *
@@ -1039,7 +1108,8 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1039
1108
  */
1040
1109
  static stringEscapeRegularExpressions(this: void, value: string, excludeSymbols?: Array<string>): string;
1041
1110
  /**
1042
- * Translates given name into a valid javaScript one. *
1111
+ * Translates given name into a valid javaScript one.
1112
+ * @param this - Indicates an unbound method.
1043
1113
  * @param name - Name to convert.
1044
1114
  * @param allowedSymbols - String of symbols which should be allowed within
1045
1115
  * a variable name (not the first character).
@@ -1052,6 +1122,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1052
1122
  * component. We need a custom method because "encodeURIComponent()" is too
1053
1123
  * aggressive and encodes stuff that doesn't have to be encoded per
1054
1124
  * "http://tools.ietf.org/html/rfc3986:".
1125
+ * @param this - Indicates an unbound method.
1055
1126
  * @param url - URL to encode.
1056
1127
  * @param encodeSpaces - Indicates whether given url should encode
1057
1128
  * whitespaces as "+" or "%20".
@@ -1061,6 +1132,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1061
1132
  static stringEncodeURIComponent(this: void, url: string, encodeSpaces?: boolean): string;
1062
1133
  /**
1063
1134
  * Appends a path selector to the given path if there isn't one yet.
1135
+ * @param this - Indicates an unbound method.
1064
1136
  * @param path - The path for appending a selector.
1065
1137
  * @param pathSeparator - The selector for appending to path.
1066
1138
  *
@@ -1069,6 +1141,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1069
1141
  static stringAddSeparatorToPath(this: void, path: string, pathSeparator?: string): string;
1070
1142
  /**
1071
1143
  * Checks if given path has given path prefix.
1144
+ * @param this - Indicates an unbound method.
1072
1145
  * @param prefix - Path prefix to search for.
1073
1146
  * @param path - Path to search in.
1074
1147
  * @param separator - Delimiter to use in path (default is the posix
@@ -1081,6 +1154,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1081
1154
  * Extracts domain name from given url. If no explicit domain name given
1082
1155
  * current domain name will be assumed. If no parameter given current
1083
1156
  * domain name will be determined.
1157
+ * @param this - Indicates an unbound method.
1084
1158
  * @param url - The url to extract domain from.
1085
1159
  * @param fallback - The fallback host name if no one exits in given url
1086
1160
  * (default is current hostname).
@@ -1093,20 +1167,19 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1093
1167
  * and no fallback is defined current port number will be assumed for local
1094
1168
  * links. For external links 80 will be assumed for http protocols and 443
1095
1169
  * for https protocols.
1170
+ * @param this - Indicates an unbound method.
1096
1171
  * @param url - The url to extract port from.
1097
1172
  * @param fallback - Fallback port number if no explicit one was found.
1098
1173
  * Default is derived from current protocol name.
1099
- * @param parameter - Additional parameter for checking if given url is an
1100
- * internal url. Given url and this parameter will be forwarded to the
1101
- * "stringServiceURLEquals()" method.
1102
1174
  *
1103
1175
  * @returns Extracted port number.
1104
1176
  */
1105
- static stringGetPortNumber(this: void, url?: string, fallback?: null | number, parameter?: Array<string>): null | number;
1177
+ static stringGetPortNumber(this: void, url?: string, fallback?: null | number): null | number;
1106
1178
  /**
1107
1179
  * Extracts protocol name from given url. If no explicit url is given,
1108
1180
  * current protocol will be assumed. If no parameter given current protocol
1109
1181
  * number will be determined.
1182
+ * @param this - Indicates an unbound method.
1110
1183
  * @param url - The url to extract protocol from.
1111
1184
  * @param fallback - Fallback port to use if no protocol exists in given
1112
1185
  * url (default is current protocol).
@@ -1117,6 +1190,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1117
1190
  /**
1118
1191
  * Read a page's GET URL variables and return them as an associative array
1119
1192
  * and preserves ordering.
1193
+ * @param this - Indicates an unbound method.
1120
1194
  * @param keyToGet - If provided the corresponding value for given key is
1121
1195
  * returned or full object otherwise.
1122
1196
  * @param allowDuplicates - Indicates whether to return arrays of values or
@@ -1145,6 +1219,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1145
1219
  /**
1146
1220
  * Checks if given url points to another "service" than second given url.
1147
1221
  * If no second given url provided current url will be assumed.
1222
+ * @param this - Indicates an unbound method.
1148
1223
  * @param url - URL to check against second url.
1149
1224
  * @param referenceURL - URL to check against first url.
1150
1225
  *
@@ -1154,6 +1229,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1154
1229
  static stringServiceURLEquals(this: void, url: string, referenceURL?: string): boolean;
1155
1230
  /**
1156
1231
  * Normalized given website url.
1232
+ * @param this - Indicates an unbound method.
1157
1233
  * @param url - Uniform resource locator to normalize.
1158
1234
  *
1159
1235
  * @returns Normalized result.
@@ -1161,6 +1237,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1161
1237
  static stringNormalizeURL(this: void, url: string): string;
1162
1238
  /**
1163
1239
  * Represents given website url.
1240
+ * @param this - Indicates an unbound method.
1164
1241
  * @param url - Uniform resource locator to represent.
1165
1242
  *
1166
1243
  * @returns Represented result.
@@ -1168,6 +1245,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1168
1245
  static stringRepresentURL(this: void, url: unknown): string;
1169
1246
  /**
1170
1247
  * Converts a camel cased string to its delimited string version.
1248
+ * @param this - Indicates an unbound method.
1171
1249
  * @param value - The string to format.
1172
1250
  * @param delimiter - Delimiter string
1173
1251
  * @param abbreviations - Collection of shortcut words to represent upper
@@ -1175,9 +1253,10 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1175
1253
  *
1176
1254
  * @returns The formatted string.
1177
1255
  */
1178
- static stringCamelCaseToDelimited(this: void, string: string, delimiter?: string, abbreviations?: Array<string> | null): string;
1256
+ static stringCamelCaseToDelimited(this: void, value: string, delimiter?: string, abbreviations?: Array<string> | null): string;
1179
1257
  /**
1180
1258
  * Converts a string to its capitalize representation.
1259
+ * @param this - Indicates an unbound method.
1181
1260
  * @param string - The string to format.
1182
1261
  *
1183
1262
  * @returns The formatted string.
@@ -1185,6 +1264,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1185
1264
  static stringCapitalize(this: void, string: string): string;
1186
1265
  /**
1187
1266
  * Compresses given style attribute value.
1267
+ * @param this - Indicates an unbound method.
1188
1268
  * @param styleValue - Style value to compress.
1189
1269
  *
1190
1270
  * @returns The compressed value.
@@ -1192,6 +1272,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1192
1272
  static stringCompressStyleValue(this: void, styleValue: string): string;
1193
1273
  /**
1194
1274
  * Decodes all html symbols in text nodes in given html string.
1275
+ * @param this - Indicates an unbound method.
1195
1276
  * @param htmlString - HTML string to decode.
1196
1277
  *
1197
1278
  * @returns Decoded html string.
@@ -1199,7 +1280,8 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1199
1280
  static stringDecodeHTMLEntities(this: void, htmlString: string): null | string;
1200
1281
  /**
1201
1282
  * Converts a delimited string to its camel case representation.
1202
- * @param string - The string to format.
1283
+ * @param this - Indicates an unbound method.
1284
+ * @param value - The string to format.
1203
1285
  * @param delimiter - Delimiter string to use.
1204
1286
  * @param abbreviations - Collection of shortcut words to represent upper
1205
1287
  * cased.
@@ -1213,6 +1295,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1213
1295
  static stringDelimitedToCamelCase(this: void, value: string, delimiter?: string, abbreviations?: Array<string> | null, preserveWrongFormattedAbbreviations?: boolean, removeMultipleDelimiter?: boolean): string;
1214
1296
  /**
1215
1297
  * Compiles a given string as expression with given scope names.
1298
+ * @param this - Indicates an unbound method.
1216
1299
  * @param expression - The string to interpret.
1217
1300
  * @param scope - Scope to extract names from.
1218
1301
  * @param execute - Indicates whether to execute or evaluate.
@@ -1223,10 +1306,11 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1223
1306
  static stringCompile<T = string>(this: void, expression: string, scope?: Array<string> | Mapping<unknown> | string, execute?: boolean): CompilationResult<T>;
1224
1307
  /**
1225
1308
  * Evaluates a given string as expression against given scope.
1309
+ * @param this - Indicates an unbound method.
1226
1310
  * @param expression - The string to interpret.
1227
1311
  * @param scope - Scope to render against.
1228
- * @param binding - Object to apply as "this" in evaluation scope.
1229
1312
  * @param execute - Indicates whether to execute or evaluate.
1313
+ * @param binding - Object to apply as "this" in evaluation scope.
1230
1314
  *
1231
1315
  * @returns Object with error message during parsing / running or result.
1232
1316
  */
@@ -1234,6 +1318,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1234
1318
  /**
1235
1319
  * Finds the string match of given query in given target text by applying
1236
1320
  * given normalisation function to target and query.
1321
+ * @param this - Indicates an unbound method.
1237
1322
  * @param target - Target to search in.
1238
1323
  * @param query - Search string to search for.
1239
1324
  * @param normalizer - Function to use as normalisation for queries and
@@ -1246,6 +1331,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1246
1331
  /**
1247
1332
  * Performs a string formation. Replaces every placeholder "{i}" with the
1248
1333
  * i'th argument.
1334
+ * @param this - Indicates an unbound method.
1249
1335
  * @param string - The string to format.
1250
1336
  * @param additionalArguments - Additional arguments are interpreted as
1251
1337
  * replacements for string formatting.
@@ -1255,6 +1341,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1255
1341
  static stringFormat(this: void, string: string, ...additionalArguments: Array<unknown>): string;
1256
1342
  /**
1257
1343
  * Calculates the edit (levenstein) distance between two given strings.
1344
+ * @param this - Indicates an unbound method.
1258
1345
  * @param first - First string to compare.
1259
1346
  * @param second - Second string to compare.
1260
1347
  *
@@ -1264,6 +1351,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1264
1351
  /**
1265
1352
  * Validates the current string for using in a regular expression pattern.
1266
1353
  * Special regular expression chars will be escaped.
1354
+ * @param this - Indicates an unbound method.
1267
1355
  * @param value - The string to format.
1268
1356
  *
1269
1357
  * @returns The formatted string.
@@ -1271,6 +1359,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1271
1359
  static stringGetRegularExpressionValidated(this: void, value: string): string;
1272
1360
  /**
1273
1361
  * Interprets given content string as date time.
1362
+ * @param this - Indicates an unbound method.
1274
1363
  * @param value - Date time string to interpret.
1275
1364
  * @param interpretAsUTC - Identifies if given date should be interpret as
1276
1365
  * utc.
@@ -1280,6 +1369,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1280
1369
  static stringInterpretDateTime(this: void, value: string, interpretAsUTC?: boolean): Date | null;
1281
1370
  /**
1282
1371
  * Converts a string to its lower case representation.
1372
+ * @param this - Indicates an unbound method.
1283
1373
  * @param string - The string to format.
1284
1374
  *
1285
1375
  * @returns The formatted string.
@@ -1287,8 +1377,9 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1287
1377
  static stringLowerCase(this: void, string: string): string;
1288
1378
  /**
1289
1379
  * Wraps given mark strings in given target with given marker.
1380
+ * @param this - Indicates an unbound method.
1290
1381
  * @param target - String to search for marker.
1291
- * @param words - String or array of strings to search in target for.
1382
+ * @param givenWords - String or array of strings to search in target for.
1292
1383
  * @param normalizer - Pure normalisation function to use before searching
1293
1384
  * for matches.
1294
1385
  * @param marker - HTML template string to mark.
@@ -1298,6 +1389,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1298
1389
  static stringMark(this: void, target: unknown, givenWords?: Array<string> | string, normalizer?: AnyFunction, marker?: string): unknown;
1299
1390
  /**
1300
1391
  * Implements the md5 hash algorithm.
1392
+ * @param this - Indicates an unbound method.
1301
1393
  * @param value - Value to calculate md5 hash for.
1302
1394
  * @param onlyAscii - Set to true if given input has ascii characters only
1303
1395
  * to get more performance.
@@ -1307,6 +1399,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1307
1399
  static stringMD5(this: void, value: string, onlyAscii?: boolean): string;
1308
1400
  /**
1309
1401
  * Normalizes given phone number for automatic dialing or comparison.
1402
+ * @param this - Indicates an unbound method.
1310
1403
  * @param value - Number to normalize.
1311
1404
  * @param dialable - Indicates whether the result should be dialed or
1312
1405
  * represented as lossless data.
@@ -1316,13 +1409,16 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1316
1409
  static stringNormalizePhoneNumber(this: void, value: unknown, dialable?: boolean): string;
1317
1410
  /**
1318
1411
  * Normalizes given zip code for automatic address processing.
1412
+ * @param this - Indicates an unbound method.
1319
1413
  * @param value - Number to normalize.
1414
+ *
1320
1415
  * @returns Normalized number.
1321
1416
  */
1322
1417
  static stringNormalizeZipCode(this: void, value: unknown): string;
1323
1418
  /**
1324
1419
  * Converts given serialized, base64 encoded or file path given object into
1325
1420
  * a native javaScript one if possible.
1421
+ * @param this - Indicates an unbound method.
1326
1422
  * @param serializedObject - Object as string.
1327
1423
  * @param scope - An optional scope which will be used to evaluate given
1328
1424
  * object in.
@@ -1330,10 +1426,11 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1330
1426
  *
1331
1427
  * @returns The parsed object if possible and null otherwise.
1332
1428
  */
1333
- static stringParseEncodedObject<T = PlainObject>(this: void, serializedObject: string, scope?: object, name?: string): null | T;
1429
+ static stringParseEncodedObject<T = PlainObject>(this: void, serializedObject: string, scope?: Mapping<unknown>, name?: string): null | T;
1334
1430
  /**
1335
1431
  * Represents given phone number. NOTE: Currently only support german phone
1336
1432
  * numbers.
1433
+ * @param this - Indicates an unbound method.
1337
1434
  * @param value - Number to format.
1338
1435
  *
1339
1436
  * @returns Formatted number.
@@ -1341,6 +1438,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1341
1438
  static stringRepresentPhoneNumber(this: void, value: unknown): string;
1342
1439
  /**
1343
1440
  * Slices all none numbers but preserves last separator.
1441
+ * @param this - Indicates an unbound method.
1344
1442
  * @param value - String to process.
1345
1443
  *
1346
1444
  * @returns - Sliced given value.
@@ -1348,6 +1446,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1348
1446
  static stringSliceAllExceptNumberAndLastSeperator(this: void, value: string): string;
1349
1447
  /**
1350
1448
  * Slice weekday from given date representation.
1449
+ * @param this - Indicates an unbound method.
1351
1450
  * @param value - String to process.
1352
1451
  *
1353
1452
  * @returns Sliced given string.
@@ -1362,6 +1461,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1362
1461
  stringNormalizeDomNodeSelector: (selector: string) => string;
1363
1462
  /**
1364
1463
  * Determines corresponding utc timestamp for given date object.
1464
+ * @param this - Indicates an unbound method.
1365
1465
  * @param value - Date to convert.
1366
1466
  * @param inMilliseconds - Indicates whether given number should be in
1367
1467
  * seconds (default) or milliseconds.
@@ -1371,6 +1471,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1371
1471
  static numberGetUTCTimestamp(this: void, value?: Date | null | number | string, inMilliseconds?: boolean): number;
1372
1472
  /**
1373
1473
  * Checks if given object is java scripts native "Number.NaN" object.
1474
+ * @param this - Indicates an unbound method.
1374
1475
  * @param value - Value to check.
1375
1476
  *
1376
1477
  * @returns Returns whether given value is not a number or not.
@@ -1378,6 +1479,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1378
1479
  static numberIsNotANumber(this: void, value: unknown): boolean;
1379
1480
  /**
1380
1481
  * Rounds a given number accurate to given number of digits.
1482
+ * @param this - Indicates an unbound method.
1381
1483
  * @param number - The number to round.
1382
1484
  * @param digits - The number of digits after comma.
1383
1485
  *
@@ -1386,23 +1488,21 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1386
1488
  static numberRound(this: void, number: number, digits?: number): number;
1387
1489
  /**
1388
1490
  * Checks if given url response with given status code.
1491
+ * @param this - Indicates an unbound method.
1389
1492
  * @param url - Url to check reachability.
1390
- * @param givenOptions - Options to configure check:
1391
- *
1392
- * wait: Boolean indicating if we should retry until a status code will be
1393
- * given.
1394
1493
  *
1395
- * statusCodes: Status codes to check for.
1396
- *
1397
- * timeoutInSeconds: Delay after assuming given resource isn't
1398
- * available if no response is coming.
1399
- *
1400
- * pollIntervallInSeconds: Seconds between two tries to reach given url.
1401
- *
1402
- * options: Fetch options to use.
1403
- * expectedIntermediateStatusCodes: A list of expected but unwanted
1404
- * response codes. If detecting them waiting will continue until an
1405
- * expected (positiv) code occurs or timeout is reached.
1494
+ * @param givenOptions - Options to configure.
1495
+ * @param givenOptions.wait - Boolean indicating if we should retry until a
1496
+ * status code will be given.
1497
+ * @param givenOptions.statusCodes - Status codes to check for.
1498
+ * @param givenOptions.timeoutInSeconds - Delay after assuming given
1499
+ * resource isn't available if no response is coming.
1500
+ * @param givenOptions.pollIntervallInSeconds - Seconds between two tries
1501
+ * to reach given url.
1502
+ * @param givenOptions.options - Fetch options to use.
1503
+ * @param givenOptions.expectedIntermediateStatusCodes - A list of expected
1504
+ * but unwanted response codes. If detecting them waiting will continue
1505
+ * until an expected (positiv) code occurs or timeout is reached.
1406
1506
  *
1407
1507
  * @returns A promise which will be resolved if a request to given url has
1408
1508
  * finished and resulting status code matches given expected status code.
@@ -1411,20 +1511,18 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1411
1511
  static checkReachability(this: void, url: string, givenOptions?: RecursivePartial<CheckReachabilityOptions>): ReturnType<typeof fetch>;
1412
1512
  /**
1413
1513
  * Checks if given url isn't reachable.
1514
+ * @param this - Indicates an unbound method.
1414
1515
  * @param url - Url to check reachability.
1415
- * @param givenOptions - Options to configure check:
1416
- *
1417
- * wait: Boolean indicating if we should retry until a status code will be
1418
- * given.
1419
- *
1420
- * timeoutInSeconds: Delay after assuming given resource will stay
1421
- * available.
1422
- *
1423
- * pollIntervallInSeconds: Seconds between two tries to reach given url.
1424
- *
1425
- * statusCodes: Status codes to check for.
1426
1516
  *
1427
- * options: Fetch options to use.
1517
+ * @param givenOptions - Options to configure.
1518
+ * @param givenOptions.wait - Boolean indicating if we should retry until a
1519
+ * status code will be given.
1520
+ * @param givenOptions.timeoutInSeconds - Delay after assuming given
1521
+ * resource will stay available.
1522
+ * @param givenOptions.pollIntervallInSeconds - Seconds between two tries
1523
+ * to reach given url.
1524
+ * @param givenOptions.statusCodes - Status codes to check for.
1525
+ * @param givenOptions.options - Fetch options to use.
1428
1526
  *
1429
1527
  * @returns A promise which will be resolved if a request to given url
1430
1528
  * couldn't finished. Otherwise returned promise will be rejected. If
@@ -1435,6 +1533,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1435
1533
  static checkUnreachability(this: void, url: string, givenOptions?: RecursivePartial<CheckReachabilityOptions>): Promise<Error | null | Promise<Error | null>>;
1436
1534
  /**
1437
1535
  * Send given data to a given iframe.
1536
+ * @param this - Indicates an unbound method.
1438
1537
  * @param target - Name of the target iframe or the target iframe itself.
1439
1538
  * @param url - URL to send to data to.
1440
1539
  * @param data - Data holding object to send data to.
@@ -1463,6 +1562,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1463
1562
  * Copies given source directory via path to given target directory
1464
1563
  * location with same target name as source file has or copy to given
1465
1564
  * complete target directory path.
1565
+ * @param this - Indicates an unbound method.
1466
1566
  * @param sourcePath - Path to directory to copy.
1467
1567
  * @param targetPath - Target directory or complete directory location to
1468
1568
  * copy in.
@@ -1477,6 +1577,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1477
1577
  * Copies given source directory via path to given target directory
1478
1578
  * location with same target name as source file has or copy to given
1479
1579
  * complete target directory path.
1580
+ * @param this - Indicates an unbound method.
1480
1581
  * @param sourcePath - Path to directory to copy.
1481
1582
  * @param targetPath - Target directory or complete directory location to
1482
1583
  * copy in.
@@ -1491,6 +1592,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1491
1592
  * Copies given source file via path to given target directory location
1492
1593
  * with same target name as source file has or copy to given complete
1493
1594
  * target file path.
1595
+ * @param this - Indicates an unbound method.
1494
1596
  * @param sourcePath - Path to file to copy.
1495
1597
  * @param targetPath - Target directory or complete file location to copy
1496
1598
  * to.
@@ -1504,6 +1606,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1504
1606
  * Copies given source file via path to given target directory location
1505
1607
  * with same target name as source file has or copy to given complete
1506
1608
  * target file path.
1609
+ * @param this - Indicates an unbound method.
1507
1610
  * @param sourcePath - Path to file to copy.
1508
1611
  * @param targetPath - Target directory or complete file location to copy
1509
1612
  * to.
@@ -1515,6 +1618,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1515
1618
  static copyFileSync(this: void, sourcePath: string, targetPath: string, readOptions?: PlainObject, writeOptions?: PlainObject): string;
1516
1619
  /**
1517
1620
  * Checks if given path points to a valid directory.
1621
+ * @param this - Indicates an unbound method.
1518
1622
  * @param filePath - Path to directory.
1519
1623
  *
1520
1624
  * @returns A promise holding a boolean which indicates directory
@@ -1523,6 +1627,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1523
1627
  static isDirectory(this: void, filePath: string): Promise<boolean>;
1524
1628
  /**
1525
1629
  * Checks if given path points to a valid directory.
1630
+ * @param this - Indicates an unbound method.
1526
1631
  * @param filePath - Path to directory.
1527
1632
  *
1528
1633
  * @returns A boolean which indicates directory existents.
@@ -1530,6 +1635,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1530
1635
  static isDirectorySync(this: void, filePath: string): boolean;
1531
1636
  /**
1532
1637
  * Checks if given path points to a valid file.
1638
+ * @param this - Indicates an unbound method.
1533
1639
  * @param filePath - Path to directory.
1534
1640
  *
1535
1641
  * @returns A promise holding a boolean which indicates directory
@@ -1538,6 +1644,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1538
1644
  static isFile(this: void, filePath: string): Promise<boolean>;
1539
1645
  /**
1540
1646
  * Checks if given path points to a valid file.
1647
+ * @param this - Indicates an unbound method.
1541
1648
  * @param filePath - Path to file.
1542
1649
  *
1543
1650
  * @returns A boolean which indicates file existence.
@@ -1547,6 +1654,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1547
1654
  * Iterates through given directory structure recursively and calls given
1548
1655
  * callback for each found file. Callback gets file path and corresponding
1549
1656
  * stat object as argument.
1657
+ * @param this - Indicates an unbound method.
1550
1658
  * @param directoryPath - Path to directory structure to traverse.
1551
1659
  * @param callback - Function to invoke for each traversed file and
1552
1660
  * potentially manipulate further traversing.
@@ -1559,6 +1667,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1559
1667
  * Iterates through given directory structure recursively and calls given
1560
1668
  * callback for each found file. Callback gets file path and corresponding
1561
1669
  * stats object as argument.
1670
+ * @param this - Indicates an unbound method.
1562
1671
  * @param directoryPath - Path to directory structure to traverse.
1563
1672
  * @param callback - Function to invoke for each traversed file.
1564
1673
  * @param options - Options to use for nested "readdir" calls.
@@ -1572,6 +1681,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1572
1681
  * will be generated if return code is not zero. The generated Error has
1573
1682
  * a property "returnCode" which provides corresponding process return
1574
1683
  * code.
1684
+ * @param this - Indicates an unbound method.
1575
1685
  * @param resolve - Promise's resolve function.
1576
1686
  * @param reject - Promise's reject function.
1577
1687
  * @param reason - Promise target if process has a zero return code.
@@ -1584,6 +1694,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
1584
1694
  /**
1585
1695
  * Forwards given child process communication channels to corresponding
1586
1696
  * current process communication channels.
1697
+ * @param this - Indicates an unbound method.
1587
1698
  * @param childProcess - Child process meta data.
1588
1699
  *
1589
1700
  * @returns Given child process meta data.