clientnode 3.0.843 → 3.0.847

package/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { ChildProcess } from 'child_process';
-import { AnyFunction, CheckReachabilityOptions, CompareOptions, CompilationResult, Encoding, EvaluationResult, File, FirstParameter, GetterFunction, ImportFunction, LockCallbackFunction, Mapping, ObjectMaskConfiguration, Options, Page, PaginateOptions, ParametersExceptFirst, PlainObject, ProcessCloseCallback, ProcessErrorCallback, ProcessHandler, ProxyHandler, ProxyType, QueryParameters, RecursiveEvaluateable, RecursivePartial, RelativePosition, SecondParameter, Selector, SetterFunction, TimeoutPromise, $DomNode, $DomNodes, $Global, $TStatic } from './type';
+import { AnyFunction, CheckReachabilityOptions, CompareOptions, CompilationResult, Encoding, EvaluationResult, File, FirstParameter, GetterFunction, ImportFunction, LockCallbackFunction, Mapping, ObjectMaskConfiguration, Options, Page, PaginateOptions, ParametersExceptFirst, PlainObject, ProcessCloseCallback, ProcessErrorCallback, ProcessHandler, ProxyHandler, ProxyType, QueryParameters, RecursiveEvaluateable, RecursivePartial, RelativePosition, SecondParameter, Selector, SetterFunction, TimeoutPromise, $DomNodes, $Global, $T, $TStatic } from './type';
 export declare const CloseEventNames: readonly ["close", "exit", "SIGINT", "SIGTERM", "SIGQUIT", "uncaughtException"];
 export declare const ConsoleOutputMethods: readonly ["debug", "error", "info", "log", "warn"];
 export declare const ValueCopySymbol: unique symbol;
@@ -13,9 +13,51 @@ export declare const currentImport: null | ImportFunction;
 export declare const optionalRequire: <T = unknown>(id: string) => T | null;
 export declare const determine$: (() => $TStatic);
 export declare let $: $TStatic;
+/**
+ * Represents the lock state.
+ *
+ * @property locks - Mapping of lock descriptions to there corresponding
+ * callbacks.
+ */
+export declare class Lock<Type = string | void> {
+    locks: Mapping<Array<LockCallbackFunction<Type>>>;
+    /**
+     * Initializes locks.
+     * @param locks - Mapping of a lock description to callbacks for calling
+     * when given lock should be released.
+     *
+     * @returns Nothing.
+     */
+    constructor(locks?: Mapping<Array<LockCallbackFunction<Type>>>);
+    /**
+     * Calling this method introduces a starting point for a critical area with
+     * potential race conditions. The area will be binded to given description
+     * string. So don't use same names for different areas.
+     * @param description - A short string describing the critical areas
+     * properties.
+     * @param callback - A procedure which should only be executed if the
+     * interpreter isn't in the given critical area. The lock description
+     * string will be given to the callback function.
+     * @param autoRelease - Release the lock after execution of given callback.
+     *
+     * @returns Returns a promise which will be resolved after releasing lock.
+     */
+    acquire(description: string, callback?: LockCallbackFunction<Type>, autoRelease?: boolean): Promise<Type>;
+    /**
+     * Calling this method  causes the given critical area to be finished and
+     * all functions given to "acquire()" will be executed in right order.
+     * @param description - A short string describing the critical areas
+     * properties.
+     *
+     * @returns Returns the return (maybe promise resolved) value of the
+     * callback given to the "acquire" method.
+     */
+    release(description: string): Promise<Type | void>;
+}
 /**
  * Represents the semaphore state.
  * @property queue - List of waiting resource requests.
+ *
  * @property numberOfFreeResources - Number free allowed concurrent resource
  * uses.
  * @property numberOfResources - Number of allowed concurrent resource uses.
@@ -32,8 +74,8 @@ export declare class Semaphore {
     constructor(numberOfResources?: number);
     /**
      * Acquires a new resource and runs given callback if available.
-     * @returns A promise which will be resolved if requested resource
-     * is available.
+     * @returns A promise which will be resolved if requested resource is
+     * available.
      */
     acquire(): Promise<number>;
     /**
@@ -87,12 +129,10 @@ export declare class Semaphore {
  *
  * @property $domNode - $-extended dom node if one was given to the constructor
  * method.
- * @property locks - Mapping of lock descriptions to there corresponding
- * callbacks.
  *
  * @property options - Options given to the constructor.
  */
-export declare class Tools<TElement = HTMLElement, LockType = string | void> {
+export declare class Tools<TElement = HTMLElement> {
     static abbreviations: Array<string>;
     static readonly animationEndEventNames = "animationend webkitAnimationEnd oAnimationEnd MSAnimationEnd";
     static readonly classToTypeMapping: Mapping;
@@ -106,8 +146,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
     static _dateTimePatternCache: Array<RegExp>;
     static _defaultOptions: Partial<Options>;
     static _javaScriptDependentContentHandled: boolean;
-    $domNode: null | $DomNode<TElement>;
-    locks: Mapping<Array<LockCallbackFunction<LockType>>>;
+    $domNode: null | $T<TElement>;
     options: Options;
     /**
      * Triggered if current object is created via the "new" keyword. The dom
@@ -118,17 +157,15 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      * the dry concept.
      * @param $domNode - $-extended dom node to use as reference in various
      * methods.
-     * @param locks - Mapping of a lock description to callbacks for calling
-     * when given lock should be released.
      *
      * @returns Nothing.
      */
-    constructor($domNode?: $DomNode<TElement>, locks?: Mapping<Array<LockCallbackFunction<LockType>>>);
+    constructor($domNode?: $T<TElement>);
     /**
      * This method could be overwritten normally. It acts like a destructor.
      * @returns Returns the current instance.
      */
-    destructor(): Tools<TElement, LockType>;
+    destructor(): this;
     /**
      * This method should be overwritten normally. It is triggered if current
      * object was created via the "new" keyword and is called now.
@@ -136,7 +173,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns the current instance.
      */
-    initialize(options?: RecursivePartial<Options>): Promise<$DomNode<TElement>> | Promise<Tools> | Tools<TElement, LockType> | Tools;
+    initialize<R = this>(options?: RecursivePartial<Options>): R;
     /**
      * Formats given date or current via given format specification.
      * @param this - Indicates an unbound method.
@@ -160,39 +197,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns whatever the initializer method returns.
      */
-    static controller<TElement = HTMLElement, RT = ReturnType<Tools['initialize']>>(this: void, object: unknown, parameters: unknown, $domNode?: null | $DomNode<TElement>): RT | void;
-    /**
-     * Calling this method introduces a starting point for a critical area with
-     * potential race conditions. The area will be binded to given description
-     * string. So don't use same names for different areas.
-     * @param description - A short string describing the critical areas
-     * properties.
-     * @param callback - A procedure which should only be executed if the
-     * interpreter isn't in the given critical area. The lock description
-     * string will be given to the callback function.
-     * @param autoRelease - Release the lock after execution of given callback.
-     *
-     * @returns Returns a promise which will be resolved after releasing lock.
-     */
-    acquireLock(description: string, callback?: LockCallbackFunction<LockType>, autoRelease?: boolean): Promise<LockType>;
-    /**
-     * Calling this method  causes the given critical area to be finished and
-     * all functions given to "acquireLock()" will be executed in right order.
-     * @param description - A short string describing the critical areas
-     * properties.
-     *
-     * @returns Returns the return (maybe promise resolved) value of the
-     * callback given to the "acquireLock" method.
-     */
-    releaseLock(description: string): Promise<LockType | void>;
-    /**
-     * Generate a semaphore object with given number of resources.
-     * @param this - Indicates an unbound method.
-     * @param numberOfResources - Number of allowed concurrent resource uses.
-     *
-     * @returns The requested semaphore instance.
-     */
-    static getSemaphore(this: void, numberOfResources?: number): Semaphore;
+    static controller<TElement = HTMLElement>(this: void, object: unknown, parameters: unknown, $domNode?: null | $T<TElement>): unknown;
     /**
      * Determines whether its argument represents a JavaScript number.
      * @param this - Indicates an unbound method.
@@ -395,12 +400,12 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      * Normalizes class name order of current dom node.
      * @returns Current instance.
      */
-    get normalizedClassNames(): Tools<TElement, LockType>;
+    get normalizedClassNames(): this;
     /**
      * Normalizes style attributes order of current dom node.
      * @returns Returns current instance.
      */
-    get normalizedStyles(): Tools<TElement, LockType>;
+    get normalizedStyles(): this;
     /**
      * Retrieves a mapping of computed style attributes to their corresponding
      * values.
@@ -423,7 +428,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns true if both dom representations are equivalent.
      */
-    static isEquivalentDOM(this: void, first: Node | string | $DomNode<Node>, second: Node | string | $DomNode<Node>, forceHTMLString?: boolean): boolean;
+    static isEquivalentDOM(this: void, first: Node | string | $T<Node>, second: Node | string | $T<Node>, forceHTMLString?: boolean): boolean;
     /**
      * Determines where current dom node is relative to current view port
      * position.
@@ -453,9 +458,10 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
     /**
      * Removes a directive name corresponding class or attribute.
      * @param directiveName - The directive name.
+     *
      * @returns Returns current dom node.
      */
-    removeDirective(directiveName: string): null | $DomNode<TElement>;
+    removeDirective(directiveName: string): null | $T<TElement>;
     /**
      * Hide or show all marked nodes which should be displayed depending on
      * java script availability.
@@ -514,7 +520,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      * @returns Returns All $ wrapped dom nodes corresponding to given
      * selectors.
      */
-    grabDomNodes(domNodeSelectors: Mapping, wrapperDomNode?: Node | null | string | $DomNode<Node>): $DomNodes;
+    grabDomNodes(domNodeSelectors: Mapping, wrapperDomNode?: Node | null | string | $T<Node>): $DomNodes;
     /**
      * Overwrites all inherited variables from parent scope with "undefined".
      * @param this - Indicates an unbound method.
@@ -619,7 +625,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns $'s grabbed dom node.
      */
-    on<TElement = HTMLElement>(...parameters: Array<unknown>): $DomNode<TElement>;
+    on<TElement = HTMLElement>(...parameters: Array<unknown>): $T<TElement>;
     /**
      * A wrapper method fo "$.off()". It sets current plugin name as event
      * scope if no scope is given. Given arguments are modified and passed
@@ -628,7 +634,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns $'s grabbed dom node.
      */
-    off<TElement = HTMLElement>(...parameters: Array<unknown>): $DomNode<TElement>;
+    off<TElement = HTMLElement>(...parameters: Array<unknown>): $T<TElement>;
     /**
      * Adds dynamic getter and setter to any given data structure such as maps.
      * @param this - Indicates an unbound method.
@@ -1486,6 +1492,24 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      * @returns Returns the rounded number.
      */
     static numberRound(this: void, number: number, digits?: number): number;
+    /**
+     * Rounds a given number up accurate to given number of digits.
+     * @param this - Indicates an unbound method.
+     * @param number - The number to round.
+     * @param digits - The number of digits after comma.
+     *
+     * @returns Returns the rounded number.
+     */
+    static numberCeil(this: void, number: number, digits?: number): number;
+    /**
+     * Rounds a given number down accurate to given number of digits.
+     * @param this - Indicates an unbound method.
+     * @param number - The number to round.
+     * @param digits - The number of digits after comma.
+     *
+     * @returns Returns the rounded number.
+     */
+    static numberFloor(this: void, number: number, digits?: number): number;
     /**
      * Checks if given url response with given status code.
      * @param this - Indicates an unbound method.
@@ -1545,7 +1569,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns the given target as extended dom node.
      */
-    static sendToIFrame(this: void, target: $DomNode | HTMLIFrameElement | string, url: string, data: Mapping<unknown>, requestType?: string, removeAfterLoad?: boolean): $DomNode;
+    static sendToIFrame(this: void, target: $T<HTMLIFrameElement> | HTMLIFrameElement | string, url: string, data: Mapping<unknown>, requestType?: string, removeAfterLoad?: boolean): $T<HTMLIFrameElement>;
     /**
      * Send given data to a temporary created iframe.
      * @param url - URL to send to data to.
@@ -1557,7 +1581,7 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns the dynamically created iframe.
      */
-    sendToExternalURL: (url: string, data: Mapping<unknown>, requestType?: string, removeAfterLoad?: boolean) => $DomNode<HTMLIFrameElement>;
+    sendToExternalURL: (url: string, data: Mapping<unknown>, requestType?: string, removeAfterLoad?: boolean) => $T<HTMLIFrameElement>;
     /**
      * Copies given source directory via path to given target directory
      * location with same target name as source file has or copy to given
@@ -1709,13 +1733,13 @@ export declare class Tools<TElement = HTMLElement, LockType = string | void> {
      *
      * @returns Returns $'s wrapped dom node.
      */
-    _bindEventHelper: <TElement_1 = HTMLElement>(parameters: Array<unknown>, removeEvent?: boolean, eventFunctionName?: string | undefined) => $DomNode<TElement_1>;
+    _bindEventHelper: <TElement_1 = HTMLElement>(parameters: Array<unknown>, removeEvent?: boolean, eventFunctionName?: string | undefined) => $T<TElement_1>;
 }
 /**
  * Dom bound version of Tools class.
  */
-export declare class BoundTools<TElement extends HTMLElement = HTMLElement, LockType = string | void> extends Tools<TElement, LockType> {
-    $domNode: $DomNode<TElement>;
+export declare class BoundTools<TElement extends HTMLElement = HTMLElement> extends Tools<TElement> {
+    $domNode: $T<TElement>;
     readonly self: typeof BoundTools;
     /**
      * This method should be overwritten normally. It is triggered if current
@@ -1732,7 +1756,7 @@ export declare class BoundTools<TElement extends HTMLElement = HTMLElement, Lock
      *
      * @returns Nothing.
      */
-    constructor($domNode: $DomNode<TElement>, ...additionalParameters: ParametersExceptFirst<Tools['constructor']>);
+    constructor($domNode: $T<TElement>, ...additionalParameters: ParametersExceptFirst<Tools['constructor']>);
 }
 export default Tools;
 export declare const augment$: (value: $TStatic) => void;