clientnode 4.0.1427 → 4.0.1429

package/dist/filesystem.d.ts

@@ -1,138 +0,0 @@
-import { AnyFunction, Encoding, File, FileTraverseResult } from './type';
-import { ObjectEncodingOptions } from 'node:fs';
-export declare const mkdirSync: typeof import("node:fs").mkdirSync | null, readdirSync: typeof import("node:fs").readdirSync | null, readFileSync: typeof import("node:fs").readFileSync | null, statSync: typeof import("node:fs").statSync | null, writeFileSync: typeof import("node:fs").writeFileSync | null;
-/**
- * Copies given source directory via path to given target directory location
- * with same target name as source file has or copy to given complete target
- * directory path.
- * @param sourcePath - Path to directory to copy.
- * @param targetPath - Target directory or complete directory location to copy
- * in.
- * @param contents - Indicates whether we only want to copy content of source
- * path without recreating the sourcefile itself on target location.
- * @param callback - Function to invoke for each traversed file.
- * @param readOptions - Options to use for reading source file.
- * @param writeOptions - Options to use for writing to target file.
- * @returns Promise holding the determined target directory path.
- */
-export declare const copyDirectoryRecursive: (sourcePath: string, targetPath: string, contents?: boolean, callback?: AnyFunction, readOptions?: {
-    encoding: null;
-    flag: string;
-}, writeOptions?: {
-    encoding: Encoding;
-    flag: string;
-    mode: number;
-}) => Promise<string>;
-/**
- * Copies given source directory via path to given target directory location
- * with same target name as source file has or copy to given complete target
- * directory path.
- * @param sourcePath - Path to directory to copy.
- * @param targetPath - Target directory or complete directory location to copy
- * in.
- * @param contents - Indicates whether we only want to copy content of source
- * path without recreating the sourcefile itself on target location.
- * @param callback - Function to invoke for each traversed file.
- * @param readOptions - Options to use for reading source file.
- * @param writeOptions - Options to use for writing to target file.
- * @returns Determined target directory path.
- */
-export declare const copyDirectoryRecursiveSync: (sourcePath: string, targetPath: string, contents?: boolean, callback?: AnyFunction, readOptions?: {
-    encoding: null;
-    flag: string;
-}, writeOptions?: {
-    encoding: Encoding;
-    flag: string;
-    mode: number;
-}) => string;
-/**
- * Copies given source file via path to given target directory location with
- * same target name as source file has or copy to given complete target file
- * path.
- * @param sourcePath - Path to file to copy.
- * @param targetPath - Target directory or complete file location to copy to.
- * @param readOptions - Options to use for reading source file.
- * @param writeOptions - Options to use for writing to target file.
- * @returns Determined target file path.
- */
-export declare const copyFile: (sourcePath: string, targetPath: string, readOptions?: {
-    encoding: null;
-    flag: string;
-}, writeOptions?: {
-    encoding: Encoding;
-    flag: string;
-    mode: number;
-}) => Promise<string>;
-/**
- * Copies given source file via path to given target directory location with
- * same target name as source file has or copy to given complete target file
- * path.
- * @param sourcePath - Path to file to copy.
- * @param targetPath - Target directory or complete file location to copy to.
- * @param readOptions - Options to use for reading source file.
- * @param writeOptions - Options to use for writing to target file.
- * @returns Determined target file path.
- */
-export declare const copyFileSync: (sourcePath: string, targetPath: string, readOptions?: {
-    encoding: null;
-    flag: string;
-}, writeOptions?: {
-    encoding: Encoding;
-    flag: string;
-    mode: number;
-}) => string;
-/**
- * Checks if given path points to a valid directory.
- * @param filePath - Path to directory.
- * @returns A promise holding a boolean which indicates directory existence.
- */
-export declare const isDirectory: (filePath: string) => Promise<boolean>;
-/**
- * Checks if given path points to a valid directory.
- * @param filePath - Path to directory.
- * @returns A boolean which indicates directory existence.
- */
-export declare const isDirectorySync: (filePath: string) => boolean;
-/**
- * Checks if given path points to a valid file.
- * @param filePath - Path to directory.
- * @returns A promise holding a boolean which indicates directory existence.
- */
-export declare const isFile: (filePath: string) => Promise<boolean>;
-/**
- * Checks if given path points to a valid file.
- * @param filePath - Path to file.
- * @returns A boolean which indicates file existence.
- */
-export declare const isFileSync: (filePath: string) => boolean;
-/**
- * Iterates through given directory structure recursively and calls given
- * callback for each found file. Callback gets file path and corresponding stat
- * object as argument.
- * @param directoryPath - Path to directory structure to traverse.
- * @param callback - Function to invoke for each traversed file and potentially
- * manipulate further traversing in alphabetical sorted order.
- * If it returns "null" or a promise resolving to "null", no further files
- * will be traversed afterward.
- * If it handles a directory and returns "false" or a promise resolving to
- * "false" no traversing into that directory will occur.
- * @param options - Options to use for nested "readdir" calls.
- * @returns A promise holding the determined files.
- */
-export declare const walkDirectoryRecursively: (directoryPath: string, callback?: null | ((file: File) => FileTraverseResult), options?: (Encoding | (ObjectEncodingOptions & {
-    withFileTypes?: false;
-    recursive?: boolean;
-}))) => Promise<Array<File>>;
-/**
- * Iterates through given directory structure recursively and calls given
- * callback for each found file. Callback gets file path and corresponding
- * stats object as argument.
- * @param directoryPath - Path to directory structure to traverse.
- * @param callback - Function to invoke for each traversed file.
- * @param options - Options to use for nested "readdir" calls.
- * @returns Determined list if all files.
- */
-export declare const walkDirectoryRecursivelySync: (directoryPath: string, callback?: AnyFunction | null, options?: (Encoding | (ObjectEncodingOptions & {
-    withFileTypes?: false;
-    recursive?: boolean;
-}))) => Array<File>;

package/dist/function.d.ts

@@ -1,20 +0,0 @@
-import { AnyFunction } from './type';
-/**
- * Determines all parameter names from given callable (function or class,
- * ...).
- * @param callable - Function or function code to inspect.
- * @returns List of parameter names.
- */
-export declare const getParameterNames: (callable: AnyFunction | string) => Array<string>;
-/**
- * Implements the identity function.
- * @param value - A value to return.
- * @returns Returns the given value.
- */
-export declare const identity: <T>(value: T) => T;
-/**
- * Inverted filter helper to inverse each given filter.
- * @param filter - A function that filters an array.
- * @returns The inverted filter.
- */
-export declare const invertArrayFilter: <T, D = Array<unknown>>(filter: T) => T;

package/dist/index.d.ts

@@ -1,23 +0,0 @@
-export * from './array';
-export * from './domNode';
-export * from './cli';
-export * from './constants';
-export * from './context';
-export * from './cookie';
-export * from './data-transfer';
-export * from './datetime';
-export * from './expression';
-export * from './filesystem';
-export * from './function';
-export * from './indicators';
-export * from './Lock';
-export * from './number';
-export * from './object';
-export * from './process';
-export * from './require';
-export * from './scope';
-export * from './Semaphore';
-export * from './string';
-export * from './Logger';
-export * from './type';
-export * from './utility';

package/dist/indicators.d.ts

@@ -1,68 +0,0 @@
-import { AnyFunction, Mapping, PlainObject, ProxyType } from './type';
-/**
- * Determines whether its argument represents a JavaScript number.
- * @param value - Value to analyze.
- * @returns A boolean value indicating whether given object is numeric
- * like.
- */
-export declare const isNumeric: (value: unknown) => value is number;
-/**
- * Determine whether the argument is a window.
- * @param value - Value to check for.
- * @returns Boolean value indicating the result.
- */
-export declare const isWindow: (value: unknown) => value is Window;
-/**
- * Checks if given object is similar to an array and can be handled like an
- * array.
- * @param object - Object to check behavior for.
- * @returns A boolean value indicating whether given object is array like.
- */
-export declare const isArrayLike: (object: unknown) => boolean;
-/**
- * Checks whether one of the given pattern matches given string.
- * @param target - Target to check in pattern for.
- * @param pattern - List of pattern to check for.
- * @returns Value "true" if given object is matches by at leas one of the
- * given pattern and "false" otherwise.
- */
-export declare const isAnyMatching: (target: string, pattern: Array<RegExp | string>) => boolean;
-/**
- * Checks whether given object is a native object but not null.
- * @param value - Value to check.
- * @returns Value "true" if given object is a plain javaScript object and
- * "false" otherwise.
- */
-export declare const isObject: (value: unknown) => value is Mapping<unknown>;
-/**
- * Checks whether given object is a plain native object.
- * @param value - Value to check.
- * @returns Value "true" if given object is a plain javaScript object and
- * "false" otherwise.
- */
-export declare const isPlainObject: (value: unknown) => value is PlainObject;
-/**
- * Checks whether given object is a set.
- * @param value - Value to check.
- * @returns Value "true" if given object is a set and "false" otherwise.
- */
-export declare const isSet: (value: unknown) => value is Set<unknown>;
-/**
- * Checks whether given object is a map.
- * @param value - Value to check.
- * @returns Value "true" if given object is a map and "false" otherwise.
- */
-export declare const isMap: (value: unknown) => value is Map<unknown, unknown>;
-/**
- * Checks whether given object is a proxy.
- * @param value - Value to check.
- * @returns Value "true" if given object is a proxy and "false" otherwise.
- */
-export declare const isProxy: (value: unknown) => value is ProxyType;
-/**
- * Checks whether given object is a function.
- * @param value - Value to check.
- * @returns Value "true" if given object is a function and "false"
- * otherwise.
- */
-export declare const isFunction: (value: unknown) => value is AnyFunction;

package/dist/number.d.ts

@@ -1,35 +0,0 @@
-/**
- * Determines corresponding utc timestamp for given date object.
- * @param value - Date to convert.
- * @param inMilliseconds - Indicates whether given number should be in
- * seconds (default) or milliseconds.
- * @returns Determined numerous value.
- */
-export declare const getUTCTimestamp: (value?: Date | null | number | string, inMilliseconds?: boolean) => number;
-/**
- * Checks if given object is java scripts native "Number.NaN" object.
- * @param value - Value to check.
- * @returns Returns whether given value is not a number or not.
- */
-export declare const isNotANumber: (value: unknown) => boolean;
-/**
- * Rounds a given number accurate to given number of digits.
- * @param number - The number to round.
- * @param digits - The number of digits after comma.
- * @returns Returns the rounded number.
- */
-export declare const round: (number: number, digits?: number) => number;
-/**
- * Rounds a given number up accurate to given number of digits.
- * @param number - The number to round.
- * @param digits - The number of digits after comma.
- * @returns Returns the rounded number.
- */
-export declare const ceil: (number: number, digits?: number) => number;
-/**
- * Rounds a given number down accurate to given number of digits.
- * @param number - The number to round.
- * @param digits - The number of digits after comma.
- * @returns Returns the rounded number.
- */
-export declare const floor: (number: number, digits?: number) => number;

package/dist/object.d.ts

@@ -1,213 +0,0 @@
-import { IGNORE_NULL_AND_UNDEFINED_SYMBOL } from './constants';
-import { CompareOptions, GetterFunction, Mapping, ObjectMaskConfiguration, PlainObject, ProxyHandler, ProxyType, RecursiveEvaluateable, RecursivePartial, SetterFunction } from './type';
-/**
- * Adds dynamic getter and setter to any given data structure such as maps.
- * @param object - Object to proxy.
- * @param getterWrapper - Function to wrap each property get.
- * @param setterWrapper - Function to wrap each property set.
- * @param methodNames - Method names to perform actions on the given
- * object.
- * @param deep - Indicates to perform a deep wrapping of specified types.
- * @param typesToExtend - Types which should be extended (Checks are
- * performed via "value instanceof type".).
- * @returns Returns given object wrapped with a dynamic getter proxy.
- */
-export declare const addDynamicGetterAndSetter: <T = unknown>(object: T, getterWrapper?: GetterFunction | null, setterWrapper?: null | SetterFunction, methodNames?: Mapping, deep?: boolean, typesToExtend?: Array<unknown>) => ProxyType<T> | T;
-/**
- * Converts given object into its serialized json representation by
- * replacing circular references with a given provided value.
- *
- * This method traverses given object recursively and tracks of seen and
- * already serialized structures to reuse generated strings or mark a
- * circular reference.
- * @param object - Object to serialize.
- * @param determineCircularReferenceValue - Callback to create a fallback
- * value depending on given redundant value.
- * @param numberOfSpaces - Number of spaces to use for string formatting.
- * @returns The formatted json string.
- */
-export declare const convertCircularObjectToJSON: (object: unknown, determineCircularReferenceValue?: ((serializedValue: unknown, key: null | string, value: unknown, seenObjects: Map<unknown, unknown>) => unknown), numberOfSpaces?: number) => ReturnType<typeof JSON.stringify> | undefined;
-/**
- * Converts given map and all nested found maps objects to corresponding
- * object.
- * @param object - Map to convert to.
- * @param deep - Indicates whether to perform a recursive conversion.
- * @returns Given map as object.
- */
-export declare const convertMapToPlainObject: (object: unknown, deep?: boolean) => unknown;
-/**
- * Converts given plain object and all nested found objects to
- * corresponding map.
- * @param object - Object to convert to.
- * @param deep - Indicates whether to perform a recursive conversion.
- * @returns Given object as map.
- */
-export declare const convertPlainObjectToMap: (object: unknown, deep?: boolean) => unknown;
-/**
- * Replaces given pattern in each value in given object recursively with
- * given string replacement.
- * @param object - Object to convert substrings in.
- * @param pattern - Regular expression to replace.
- * @param replacement - String to use as replacement for found patterns.
- * @returns Converted object with replaced patterns.
- */
-export declare const convertSubstringInPlainObject: <Type extends Mapping<unknown> = PlainObject>(object: Type, pattern: RegExp | string, replacement: string) => Type;
-/**
- * Copies given object (of any type) into optionally given destination.
- * @param source - Object to copy.
- * @param copyBlobs - Determines whether to copy blobs as well.
- * @param recursionLimit - Specifies how deep we should traverse into given
- * object recursively.
- * @param recursionEndValue - Indicates which value to use for recursion ends.
- * Usually a reference to corresponding source value will be used.
- * @param destination - Target to copy source to.
- * @param cyclic - Indicates whether known sub structures should be copied or
- * referenced (if "true" endless loops can occur if source has cyclic
- * structures).
- * @param knownReferences - Used to avoid traversing loops and not to copy
- * references e.g. to objects not to copy (e.g. symbol polyfills).
- * @param recursionLevel - Internally used to track current recursion level in
- * given source data structure.
- * @returns Value "true" if both objects are equal and "false" otherwise.
- */
-export declare const copy: <Type = unknown>(source: Type, copyBlobs?: boolean, recursionLimit?: number, recursionEndValue?: unknown, destination?: null | Type, cyclic?: boolean, knownReferences?: Array<unknown>, recursionLevel?: number) => Type;
-/**
- * Determine the internal JavaScript [[Class]] of an object.
- * @param value - Value to analyze.
- * @returns Name of determined type.
- */
-export declare const determineType: (value?: unknown) => string;
-/**
- * Returns true if given items are equal for given property list. If
- * property list isn't set all properties will be checked. All keys which
- * starts with one of the exception prefixes will be omitted.
- * @param firstValue - First object to compare.
- * @param secondValue - Second object to compare.
- * @param givenOptions - Options to define how to compare.
- * @param givenOptions.properties - Property names to check. Check all if
- * "null" is selected (default).
- * @param givenOptions.deep - Recursion depth negative values means
- * infinitely deep (default).
- * @param givenOptions.exceptionPrefixes - Property prefixes which
- * indicates properties to ignore.
- * @param givenOptions.ignoreFunctions - Indicates whether functions have
- * to be identical to interpret is as equal. If set to "true" two functions
- * will be assumed to be equal (default).
- * @param givenOptions.compareBlobs - Indicates whether binary data should
- * be converted to a base64 string to compare their content. Makes this
- * function asynchronous in browsers and potentially takes a lot of
- * resources.
- * @returns Value "true" if both objects are equal and "false" otherwise.
- * If "compareBlobs" is activated, and we're running in a browser like
- * environment and binary data is given, then a promise wrapping the
- * determined boolean values is returned.
- */
-export declare const equals: (firstValue: unknown, secondValue: unknown, givenOptions?: Partial<CompareOptions>) => boolean | Promise<boolean | string> | string;
-/**
- * Searches for nested mappings with given indicator key and resolves
- * marked values. Additionally, all objects are wrapped with a proxy to
- * dynamically resolve nested properties.
- * @param object - Given mapping to resolve.
- * @param scope - Scope to use evaluate again.
- * @param selfReferenceName - Name to use for reference to given object.
- * @param expressionIndicatorKey - Indicator property name to mark a value
- * to evaluate.
- * @param executionIndicatorKey - Indicator property name to mark a value
- * to evaluate.
- * @returns Evaluated given mapping.
- */
-export declare const evaluateDynamicData: <Type = unknown>(object: null | RecursiveEvaluateable<Type>, scope?: Mapping<unknown>, selfReferenceName?: string, expressionIndicatorKey?: string, executionIndicatorKey?: string) => Type;
-/**
- * Removes properties in objects where a dynamic indicator lives.
- * @param data - Object to traverse recursively.
- * @param expressionIndicators - Property key to remove.
- * @returns Given object with removed properties.
- */
-export declare const removeKeysInEvaluation: <T extends Mapping<unknown> = Mapping<unknown>>(data: T, expressionIndicators?: Array<string>) => T;
-/**
- * Extends given target object with given sources object. As target and
- * sources many expandable types are allowed but target and sources have to
- * come from the same type.
- * @param targetOrDeepIndicator - Maybe the target or deep indicator.
- * @param targetOrSource - Target or source object; depending on first
- * argument.
- * @param additionalSources - Source objects to extend into target.
- * @returns Returns given target extended with all given sources.
- */
-export declare const extend: <T = Mapping<unknown>>(targetOrDeepIndicator: (boolean | typeof IGNORE_NULL_AND_UNDEFINED_SYMBOL | RecursivePartial<T>), targetOrSource?: null | RecursivePartial<T>, ...additionalSources: Array<RecursivePartial<T>>) => T;
-/**
- * Generates a proxy handler which forwards all operations to given object
- * as there wouldn't be a proxy.
- * @param target - Object to proxy.
- * @param methodNames - Mapping of operand name to object specific method
- * name.
- * @returns Determined proxy handler.
- */
-export declare const getProxyHandler: <T = unknown>(target: T, methodNames?: Mapping) => ProxyHandler<T>;
-/**
- * Slices all properties from given object which does not match provided
- * object mask. Items can be explicitly whitelisted via "include" mask
- * configuration or black listed via "exclude" mask configuration.
- * @param object - Object to slice.
- * @param maskConfiguration - Mask configuration.
- * @returns Given but sliced object. If (nested) object will be modified a
- * flat copy of that object will be returned.
- */
-export declare const mask: <Type extends Mapping<unknown> = Mapping<unknown>>(object: Type, maskConfiguration: ObjectMaskConfiguration) => RecursivePartial<Type>;
-/**
- * Modifies given target corresponding to given source and removes source
- * modification infos.
- * @param target - Object to modify.
- * @param source - Source object to load modifications from.
- * @param removeIndicatorKey - Indicator property name or value to mark a
- * value to remove from object or list.
- * @param prependIndicatorKey - Indicator property name to mark a value to
- * prepend to target list.
- * @param appendIndicatorKey - Indicator property name to mark a value to
- * append to target list.
- * @param positionPrefix - Indicates a prefix to use a value on given
- * position to add or remove.
- * @param positionSuffix - Indicates a suffix to use a value on given
- * position to add or remove.
- * @param parentSource - Source context to remove modification info from
- * (usually only needed internally).
- * @param parentKey - Source key in given source context to remove
- * modification info from (usually only needed internally).
- * @returns Given target modified with given source.
- */
-export declare const modifyObject: <T = unknown>(target: T, source: unknown, removeIndicatorKey?: string, prependIndicatorKey?: string, appendIndicatorKey?: string, positionPrefix?: string, positionSuffix?: string, parentSource?: unknown, parentKey?: unknown) => T;
-/**
- * Removes given key from given object recursively.
- * @param object - Object to process.
- * @param keys - List of keys to remove.
- * @returns Processed given object.
- */
-export declare const removeKeyPrefixes: <T>(object: T, keys?: Array<string> | string) => T;
-/**
- * Represents given object as formatted string.
- * @param object - Object to represent.
- * @param maximumLengthOfLists - Maximum number of array item to render.
- * @param indention - String (usually whitespaces) to use as indention.
- * @param initialIndention - String (usually whitespaces) to use as
- * additional indention for the first object traversing level.
- * @param maximumNumberOfLevelsReachedIdentifier - Replacement for objects
- * which are out of specified bounds to traverse.
- * @param numberOfLevels - Specifies number of levels to traverse given
- * data structure.
- * @returns Representation string.
- */
-export declare const represent: (object: unknown, maximumLengthOfLists?: number, indention?: string, initialIndention?: string, maximumNumberOfLevelsReachedIdentifier?: number | string, numberOfLevels?: number) => string;
-/**
- * Sort given objects keys.
- * @param object - Object which keys should be sorted.
- * @returns Sorted list of given keys.
- */
-export declare const sort: (object: unknown) => Array<unknown>;
-/**
- * Removes a proxy from given data structure recursively.
- * @param object - Object to proxy.
- * @param seenObjects - Tracks all already processed objects to avoid
- * endless loops (usually only needed for internal purpose).
- * @returns Returns given object unwrapped from a dynamic proxy.
- */
-export declare const unwrapProxy: <T = unknown>(object: ProxyType<T> | T, seenObjects?: Set<unknown>) => T;

package/dist/process.d.ts

@@ -1,22 +0,0 @@
-import { ChildProcess } from 'child_process';
-import { AnyFunction, ProcessCloseCallback, ProcessErrorCallback, ProcessHandler } from './type';
-/**
- * Generates a one shot close handler which triggers given promise methods.
- * If a reason is provided it will be given as resolve target. An Error will be
- * generated if return code is not zero. The generated Error has a property
- * "returnCode" which provides corresponding process return code.
- * @param resolve - Promise's resolve function.
- * @param reject - Promise's reject function.
- * @param reason - Promise target if process has a zero return code.
- * @param callback - Optional function to call of process has successfully
- * finished.
- * @returns Process close handler function.
- */
-export declare const getProcessCloseHandler: (resolve: ProcessCloseCallback, reject: ProcessErrorCallback, reason?: unknown, callback?: AnyFunction) => ProcessHandler;
-/**
- * Forwards given child process communication channels to corresponding current
- * process communication channels.
- * @param childProcess - Child process meta data.
- * @returns Given child process meta data.
- */
-export declare const handleChildProcess: (childProcess: ChildProcess) => ChildProcess;