clientnode 4.0.1393 → 4.0.1395

package/dist/domNode.d.ts

@@ -14,9 +14,9 @@ export declare const getText: (root: Node, recursive?: boolean) => Array<string>
 /**
  * Checks whether given html or text strings are equal.
  * @param first - First html, selector to dom node or text to compare.
- * @param second - Second html, selector to dom node  or text to compare.
+ * @param second - Second html, selector to dom node or text to compare.
  * @param forceHTMLString - Indicates whether given contents are
- * interpreted as html string (otherwise an automatic detection will be
+ * interpreted as html string (otherwise automatic detection will be
  * triggered).
  * @returns Returns true if both dom representations are equivalent.
  */
@@ -34,7 +34,7 @@ export declare const isEquivalent: (first: Node | string, second: Node | string,
 export declare const isHidden: (domNode: HTMLElement) => boolean;
 export declare const onDocumentReady: (callback?: () => void) => Promise<void>;
 /**
- * Replaces given dom node with given nodes.
+ * Replaces a given dom node with given nodes.
  * @param domNodeToReplace - Node to replace its children.
  * @param replacementDomNodes - Node or array of nodes to use as replacement.
  * @param skipEmptyTextNodes - Configures whether to trim text.
@@ -42,7 +42,8 @@ export declare const onDocumentReady: (callback?: () => void) => Promise<void>;
 export declare const replace: (domNodeToReplace: HTMLElement, replacementDomNodes: Array<Node> | Node, skipEmptyTextNodes?: boolean) => void;
 export declare const wrap: (domNodes: Node | NodeListOf<Node>, wrapper: HTMLElement) => void;
 /**
- * Moves content of given dom node one level up and removes given node.
+ * Moves the content of a given dom node one level up and removes the given
+ * node.
  * @param domNode - Node to unwrap.
  * @returns List of unwrapped nodes.
  */

package/dist/string.d.ts

@@ -6,7 +6,7 @@ export declare const ALLOWED_VARIABLE_SYMBOLS = "0-9a-zA-Z_$";
 export declare const ALLOWED_STARTING_VARIABLE_SYMBOLS = "a-zA-Z_$";
 export declare const FIX_ENCODING_ERROR_MAPPING: readonly [readonly ["Ã\\x84", "Ä"], readonly ["Ã\\x96", "Ö"], readonly ["Ã\\x9c", "Ü"], readonly ["ä", "ä"], readonly ["ö", "ö"], readonly ["ü", "ü"], readonly ["\\x96", "-"], readonly ["é", "é"], readonly ["è", "e"], readonly ["ô", "o"], readonly ["à ", "á"], readonly ["ø", "ø"], readonly ["Ã\\x9f", "ß"], readonly ["Ã", "ß"]];
 /**
- * Translates given string into the regular expression validated
+ * Translates a given string into the regular expression validated
  * representation.
  * @param value - String to convert.
  * @param excludeSymbols - Symbols not to escape.
@@ -14,13 +14,13 @@ export declare const FIX_ENCODING_ERROR_MAPPING: readonly [readonly ["Ã\\x84",
  */
 export declare const escapeRegularExpressions: (value: string, excludeSymbols?: Array<string>) => string;
 /**
- * Translates given name into a valid javaScript one.
+ * Translates a given name into a valid JavaScript one.
  * @param name - Name to convert.
  * @returns Converted name is returned.
  */
 export declare const convertToValidVariableName: (name: string) => string;
 /**
- * This method is intended for encoding *key* or *value* parts of query
+ * This method is intended for encoding *key* or *value* parts of a query
  * component. We need a custom method because "encodeURIComponent()" is too
  * aggressive and encodes stuff that doesn't have to be encoded per
  * "http://tools.ietf.org/html/rfc3986:".
@@ -33,22 +33,22 @@ export declare const encodeURIComponentExtended: (url: string, encodeSpaces?: bo
 /**
  * Appends a path selector to the given path if there isn't one yet.
  * @param path - The path for appending a selector.
- * @param pathSeparator - The selector for appending to path.
+ * @param pathSeparator - The selector for appending to a path.
  * @returns The appended path.
  */
 export declare const addSeparatorToPath: (path: string, pathSeparator?: string) => string;
 /**
- * Checks if given path has given path prefix.
+ * Checks if a given path has given path prefix.
  * @param prefix - Path prefix to search for.
  * @param path - Path to search in.
- * @param separator - Delimiter to use in path (default is the posix
+ * @param separator - Delimiter to use in a path (default is the posix
  * conform slash).
- * @returns Value "true" if given prefix occur and "false" otherwise.
+ * @returns Value "true" if given prefix occurs and "false" otherwise.
  */
 export declare const hasPathPrefix: (prefix?: unknown, path?: string, separator?: string) => boolean;
 /**
  * Extracts domain name from given url. If no explicit domain name given
- * current domain name will be assumed. If no parameter given current
+ * current domain name will be assumed. If no parameter is given, the current
  * domain name will be determined.
  * @param url - The url to extract domain from.
  * @param fallback - The fallback host name if no one exits in given url
@@ -57,20 +57,20 @@ export declare const hasPathPrefix: (prefix?: unknown, path?: string, separator?
  */
 export declare const getDomainName: (url?: string, fallback?: string) => string;
 /**
- * Extracts port number from given url. If no explicit port number given
- * and no fallback is defined current port number will be assumed for local
+ * Extracts port number from given url. If no explicit port number is given
+ * and no fallback is defined, the current port number will be assumed for local
  * links. For external links 80 will be assumed for http protocols and 443
  * for https protocols.
  * @param url - The url to extract port from.
  * @param fallback - Fallback port number if no explicit one was found.
- * Default is derived from current protocol name.
+ * Default is derived from the current protocol name.
  * @returns Extracted port number.
  */
 export declare const getPortNumber: (url?: string, fallback?: null | number) => null | number;
 /**
  * Extracts protocol name from given url. If no explicit url is given,
- * current protocol will be assumed. If no parameter given current protocol
- * number will be determined.
+ * the current protocol will be assumed. If no parameter is given, the current
+ * protocol number will be determined.
  * @param url - The url to extract protocol from.
  * @param fallback - Fallback port to use if no protocol exists in given
  * url (default is current protocol).
@@ -80,33 +80,33 @@ export declare const getProtocolName: (url?: string, fallback?: string) => strin
 /**
  * Read a page's GET URL variables and return them as an associative array
  * and preserves ordering.
- * @param keyToGet - If provided the corresponding value for given key is
+ * @param keyToGet - If provided the corresponding value for a given key is
  * returned or full object otherwise.
  * @param allowDuplicates - Indicates whether to return arrays of values or
  * single values. If set to "false" (default) last values will overwrite
  * preceding values.
  * @param givenInput - An alternative input to the url search parameter. If
- * "#" is given the complete current hashtag will be interpreted as url and
- * search parameter will be extracted from there. If "&" is given classical
- * search parameter and hash parameter will be taken in account. If a search
- * string is given this will be analyzed. The default is to take given search
- * part into account.
+ * "#" is given, the complete current hashtag will be interpreted as url and
+ * search parameter will be extracted from there. If "&" is given a classical
+ * search parameter, and hash parameter will be taken in an account. If a
+ * search string is given, this will be analyzed. The default is to take a
+ * given search part into account.
  * @param subDelimiter - Defines which sequence indicates the start of
  * parameter in a hash part of the url.
  * @param hashedPathIndicator - If defined and given hash starts with this
- * indicator given hash will be interpreted as path containing search and
+ * indicator, given hash will be interpreted as a path containing search and
  * hash parts.
  * @param givenSearch - Search part to take into account defaults to
  * current url search part.
  * @param givenHash - Hash part to take into account defaults to current
  * url hash part.
- * @returns Returns the current get array or requested value. If requested
- * key doesn't exist "undefined" is returned.
+ * @returns Returns the current get array or requested value. If the requested
+ * key doesn't exist, "undefined" is returned.
  */
 export declare const getURLParameter: (keyToGet?: null | string, allowDuplicates?: boolean, givenInput?: null | string, subDelimiter?: string, hashedPathIndicator?: string, givenSearch?: null | string, givenHash?: null | string) => Array<string> | null | QueryParameters | string;
 /**
- * Checks if given url points to another "service" than second given url.
- * If no second given url provided current url will be assumed.
+ * Checks if given url points to another "service" than the second given url.
+ * If no second given url is provided, the current url will be assumed.
  * @param url - URL to check against second url.
  * @param referenceURL - URL to check against first url.
  * @returns Returns "true" if given first url has same domain as given
@@ -126,7 +126,7 @@ export declare const normalizeURL: (givenURL: unknown) => string;
  */
 export declare const representURL: (url: unknown) => string;
 /**
- * Converts a camel cased string to its delimited string version.
+ * Converts a camel-cased string to its delimited string version.
  * @param value - The string to format.
  * @param delimiter - Defines delimiter string.
  * @param abbreviations - Collection of shortcut words to represent uppercased.
@@ -134,7 +134,7 @@ export declare const representURL: (url: unknown) => string;
  */
 export declare const camelCaseToDelimited: (value: string, delimiter?: string, abbreviations?: Array<string> | null) => string;
 /**
- * Converts a string to its capitalize representation.
+ * Converts a string to its capitalized representation.
  * @param string - The string to format.
  * @returns The formatted string.
  */
@@ -146,7 +146,7 @@ export declare const capitalize: (string: string) => string;
  */
 export declare const compressStyleValue: (styleValue: string) => string;
 /**
- * Decodes all html symbols in text nodes in given html string.
+ * Decodes all html symbols in text nodes in a given html string.
  * @param htmlString - HTML string to decode.
  * @returns Decoded html string.
  */
@@ -164,7 +164,7 @@ export declare const decodeHTMLEntities: (htmlString: string) => null | string;
  */
 export declare const delimitedToCamelCase: (value: string, delimiter?: string, abbreviations?: Array<string> | null, preserveWrongFormattedAbbreviations?: boolean, removeMultipleDelimiter?: boolean) => string;
 /**
- * Compiles a given string as expression with given scope names.
+ * Compiles a given string as an expression with given scope names.
  * @param expression - The string to interpret.
  * @param scope - Scope to extract names from.
  * @param execute - Indicates whether to execute or evaluate.
@@ -176,25 +176,25 @@ export declare const delimitedToCamelCase: (value: string, delimiter?: string, a
  */
 export declare const compile: <T = string, N extends Array<string> = Array<string>>(expression: string, scope?: Mapping<unknown> | N | N[number] | string, execute?: boolean, removeGlobalScope?: boolean, binding?: unknown) => CompilationResult<T, N>;
 /**
- * Evaluates a given string as expression against given scope.
+ * Evaluates a given string as an expression against a given scope.
  * @param expression - The string to interpret.
  * @param scope - Scope to render against.
  * @param execute - Indicates whether to execute or evaluate.
  * @param removeGlobalScope - Indicates whether to shadow global variables via
  * "undefined".
  * @param binding - Object to apply as "this" in evaluation scope.
- * @returns Object with error message during parsing / running or result.
+ * @returns Object with an error message during parsing / running or result.
  */
 export declare const evaluate: <T = string, S extends object = object>(expression: string, scope?: S, execute?: boolean, removeGlobalScope?: boolean, binding?: unknown) => EvaluationResult<T>;
 /**
- * Finds the string match of given query in given target text by applying given
- * normalisation function to target and query.
+ * Finds the string match of a given query in a given target text by applying a
+ * given normalization function to target and query.
  * @param target - Target to search in.
  * @param query - Search string to search for.
- * @param normalizer - Function to use as normalisation for queries and search
+ * @param normalizer - Function to use as normalization for queries and search
  * targets.
- * @param skipTagDelimitedParts - Indicates whether to for example ignore html
- * tags via "['<', '>']" (the default).
+ * @param skipTagDelimitedParts - Indicates whether to, for example, ignore
+ * html tags via "['<', '>']" (the default).
  * @returns Start and end index of matching range.
  */
 export declare const findNormalizedMatchRange: (target: unknown, query: unknown, normalizer?: (value: unknown) => string, skipTagDelimitedParts?: null | [string, string]) => Array<number> | null;
@@ -234,20 +234,20 @@ export declare const maskForRegularExpression: (value: string) => string;
  */
 export declare const lowerCase: (string: string) => string;
 /**
- * Wraps given mark strings in given target with given marker.
+ * Wraps given mark strings in a given target with a given marker.
  * @param target - String to search for marker.
  * @param givenWords - String or array of strings to search in target for.
  * @param givenOptions - Defines highlighting behavior.
  * @param givenOptions.marker - HTML template string to mark.
- * @param givenOptions.normalizer - Pure normalisation function to use before
+ * @param givenOptions.normalizer - Pure normalization function to use before
  * searching for matches.
- * @param givenOptions.skipTagDelimitedParts - Indicates whether to for example
- * ignore html tags via "['<', '>']" (the default).
+ * @param givenOptions.skipTagDelimitedParts - Indicates whether to, for
+ * example, ignore html tags via "['<', '>']" (the default).
  * @returns Processed result.
  */
 export declare const mark: (target: unknown, givenWords?: Array<string> | string, givenOptions?: Partial<StringMarkOptions>) => unknown;
 /**
- * Normalizes given phone number for automatic dialing or comparison.
+ * Normalizes a given phone number for automatic dialing or comparison.
  * @param value - Number to normalize.
  * @param dialable - Indicates whether the result should be dialed or
  * represented as lossless data.
@@ -255,14 +255,14 @@ export declare const mark: (target: unknown, givenWords?: Array<string> | string
  */
 export declare const normalizePhoneNumber: (value: unknown, dialable?: boolean) => string;
 /**
- * Normalizes given zip code for automatic address processing.
+ * Normalizes a given zip code for automatic address processing.
  * @param value - Number to normalize.
  * @returns Normalized number.
  */
 export declare const normalizeZipCode: (value: unknown) => string;
 /**
- * Converts given serialized, base64 encoded or file path given object into a
- * native javaScript one if possible.
+ * Converts a given serialized, base64 encoded or file path given object into a
+ * native JavaScript one if possible.
  * @param serializedObject - Object as string.
  * @param scope - An optional scope which will be used to evaluate given object
  * in.
@@ -271,7 +271,7 @@ export declare const normalizeZipCode: (value: unknown) => string;
  */
 export declare const parseEncodedObject: <T = PlainObject>(serializedObject: string, scope?: Mapping<unknown>, name?: string) => null | T;
 /**
- * Represents given phone number. NOTE: Currently only support german phone
+ * Represents a given phone number. NOTE: Currently only support German phone
  * numbers.
  * @param value - Number to format.
  * @returns Formatted number.
@@ -291,7 +291,7 @@ export declare const sliceAllExceptNumberAndLastSeparator: (value: string) => st
  */
 export declare const normalizeDomNodeSelector: (selector: string, selectorPrefix?: string) => string;
 /**
- * Abbreviates given string if it excesses a given limit.
+ * Abbreviates a given string if it excesses a given limit.
  * @param value - String to abbreviate.
  * @param limit - Maximum length of processed string.
  * @returns Abbreviated given string.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clientnode",
-  "version": "4.0.1393",
+  "version": "4.0.1395",
   "description": "upgrade to object orientated rock solid plugins",
   "keywords": [
     "client",
@@ -96,7 +96,7 @@
     "prop-types": "^15.8.1",
     "rimraf": "^6.1.3",
     "typescript-eslint": "^8.59.2",
-    "web-documentation": "^1.0.6",
+    "web-documentation": "^1.0.8",
     "weboptimizer": "^3.0.22",
     "webpack-dev-server": "^5.2.3"
   },