@nativerent/js-utils 1.2.1 → 1.2.3

package/dist/index.d.ts

@@ -1,140 +1,123 @@
-type FlattenableObject = { [key: string]: any };
-
-type Primitive = boolean | number | string;
-
-type SimpleObject = {
-  [key: string | number]: Primitive | Primitive[] | null | undefined;
-};
-
-declare function debounce(fn: Function, delay: number): () => void;
-declare function throttle(fn: Function, delay: number): (...args: any[]) => void;
-declare function isObject(value: any): value is object;
-declare function isFn(value: any): value is Function;
-declare function isStr(value: any): boolean;
-declare function isString(value: any): value is string;
+import type { Primitive, SimpleObject } from "./types";
+export declare function debounce(fn: Function, delay: number): () => void;
+export declare function throttle(fn: Function, delay: number): (...args: any[]) => void;
+export declare function isObject(value: any): value is object;
+export declare function isFn(value: any): value is Function;
+export declare function isStr(value: any): boolean;
+export declare function isString(value: any): value is string;
 /**
  * Check if the given argument is a string which is not empty
  */
-declare function isNotEmptyString(value: any): number | false;
-declare function isHTMLElement(value: any): value is HTMLElement;
-declare function isNum(value: any): value is number;
-declare function isBool(value: any): value is boolean;
-declare function isUndef(value: any): value is undefined;
-declare function isNullOrUndef(value: unknown): value is null | undefined;
-declare function isDefined(value: any): boolean;
+export declare function isNotEmptyString(value: any): boolean;
+export declare function isHTMLElement(value: any): value is HTMLElement;
+export declare function isNum(value: any): value is number;
+export declare function isBool(value: any): value is boolean;
+export declare function isUndef(value: any): value is undefined;
+export declare function isNullOrUndef(value: unknown): value is null | undefined;
+export declare function isDefined(value: any): boolean;
 /**
  * Returns an array containing all the elements of array1 that are not in array2 and vice-versa
  */
-declare function arrayDiff(array1: Array<Primitive | null | undefined>, array2: Array<Primitive | null | undefined>): Array<Primitive | null | undefined>;
+export declare function arrayDiff(array1: Array<Primitive | null | undefined>, array2: Array<Primitive | null | undefined>): Array<Primitive | null | undefined>;
 /**
  * Returns an array of elements present in array1 and array2
  */
-declare function arrayIntersect(array1: Array<Primitive | null | undefined>, array2: Array<Primitive | null | undefined>): (Primitive | null | undefined)[];
-declare function deepCloneObject<Type>(object: Type): Type;
-declare function getNumericStyleProp(prop: string, el: Element): number;
-declare function objectHasProp(obj: any, prop: string | number | symbol): boolean;
+export declare function arrayIntersect(array1: Array<Primitive | null | undefined>, array2: Array<Primitive | null | undefined>): (Primitive | null | undefined)[];
+export declare function deepCloneObject<Type>(object: Type): Type;
+export declare function getNumericStyleProp(prop: string, el: Element): number;
+export declare function objectHasProp(obj: any, prop: string | number | symbol): boolean;
 /**
  * Custom version of Object.keys()
  */
-declare function getObjectKeys(object: object): string[];
+export declare function getObjectKeys(object: object): string[];
 /**
  * Convert an object to a query string
  * Works with primitive objects
  */
-declare function objectToQueryString(object: {
+export declare function objectToQueryString(object: {
     [key: string | number]: Primitive | Array<Primitive | null | undefined> | SimpleObject | {
         [key: string | number]: SimpleObject;
     } | undefined | null;
 }): string;
-declare function countObjectInnerLength(object: {
-    [key: string | number]: any[];
-}): number | any[];
+export declare function countObjectInnerLength(object: Record<string | number, any[] | null | undefined>): number;
 /**
  * Check if the element is in viewport
  */
-declare function isElementVisible(element: HTMLElement, minVisiblePercent?: number): boolean;
-declare function decodeSafeURL(url: string): string;
-declare function getSafeURL(url?: string): string;
-declare function parseURL(url: string): URL;
-declare function encodeQueryString(url: string): string;
-declare function injectScript(filename: string): void;
-declare function injectStyleLink(filename: string): void;
-declare function toBinaryStr(str: string): string;
+export declare function isElementVisible(element: HTMLElement, minVisiblePercent?: number): boolean;
+export declare function decodeSafeURL(url: string): string;
+export declare function getSafeURL(url?: string): string;
+export declare function parseURL(url: string): URL;
+export declare function encodeQueryString(url: string): string;
+export declare function injectScript(filename: string): void;
+export declare function injectStyleLink(filename: string): void;
+export declare function toBinaryStr(str: string): string;
 /**
  * Find a DOM element where an ad unit should be rendered to
  */
-declare function getHtmlElement(id: string): HTMLElement | null;
+export declare function getHtmlElement(id: string): HTMLElement | null;
 /**
  * Convert an HTML string into a list of nodes
  */
-declare function stringToHtmlElements(html: string): NodeListOf<ChildNode>;
+export declare function stringToHtmlElements(html: string): NodeListOf<ChildNode>;
 /**
  * Creates an HTML element and sets attributes
  */
-declare function createHtmlElement(type: string, attributes?: {
-    [key: string]: string;
-}): HTMLElement;
+export declare function createHtmlElement(type: string, attributes?: Record<string, string>): HTMLElement;
 /**
  * Insert HTML elements into DOM
  */
-declare function insertHtmlElements(nodes: NodeListOf<Node>, appendTo?: Element | ShadowRoot): void;
+export declare function insertHtmlElements(nodes: NodeListOf<Node>, appendTo?: Element | ShadowRoot): void;
 /**
  * Make a simple object which contains only attribute name and value
  */
-declare function flatHtmlAttributes(attributes?: NamedNodeMap): {
-    [key: string]: string;
-};
+export declare function flatHtmlAttributes(attributes?: NamedNodeMap | null): Record<string, string>;
 /**
  * Create a <script> element
  */
-declare function createScriptElement(js: string, inline?: boolean, attributes?: {
-    [key: string]: string;
-}): HTMLScriptElement;
+export declare function createScriptElement(js: string, inline?: boolean, attributes?: Record<string, string>): HTMLScriptElement;
 /**
  * Create a <style> element
  */
-declare function createStyleElement(css: string | null): HTMLElement;
+export declare function createStyleElement(css: string | null): HTMLStyleElement;
 /**
  * Create a <link> element
  */
-declare function createLinkElement(href: string): HTMLLinkElement;
+export declare function createLinkElement(href: string): HTMLLinkElement;
 /**
  * Create svg elements
  */
-declare function createSvgElement(content: string, attributes: {
-    [key: string]: string;
-}): SVGSVGElement;
+export declare function createSvgElement(content: string, attributes?: Record<string, string>): SVGSVGElement;
 /**
  * Create an image element to use as a tracking pixel
  */
-declare function createPixelElement(src: string): HTMLImageElement;
+export declare function createPixelElement(src: string): HTMLImageElement;
 /**
  * Append a new script element to the DOM head
  */
-declare function insertJs(js: string, inline?: boolean): void;
+export declare function insertJs(js: string, inline?: boolean): void;
 /**
  * Append a new style element to the DOM head
  */
-declare function insertCss(css: string, className?: string, external?: boolean): void;
+export declare function insertCss(css: string, className?: string, external?: boolean): void;
 /**
  * Get screen sizes
  */
-declare function getScreenSize(): {
+export declare function getScreenSize(): {
     width: number;
     height: number;
 };
 /**
  * Get a random integer between min and max
  */
-declare function getRandomInt(min?: number, max?: number): number;
+export declare function getRandomInt(min?: number, max?: number): number;
 /**
  * Implementation of Java's String.hashCode() method
  */
-declare function hashCode(str: string): number;
+export declare function hashCode(str: string): number;
 /**
  * Executes a callback as soon as DOM is interactive
  */
-declare function onDOMReady(callback: Function, ...args: any[]): void;
+export declare function onDOMReady<T extends unknown[]>(callback: (...args: T) => void, ...args: T): void;
 /**
  * Calculate the percentage of two values
  *
@@ -142,41 +125,41 @@ declare function onDOMReady(callback: Function, ...args: any[]): void;
  * @param b
  * @return number
  */
-declare function toPercent(a: number, b: number): number;
+export declare function toPercent(a: number, b: number): number;
 /**
  * Make a camelCase string
  *
  * @param string
  * @return string
  */
-declare function toCamelCase(string: string): string;
+export declare function toCamelCase(string: string): string;
 /**
  * Make a snake_case string
  *
  * @param string
  * @return string
  */
-declare function toSnakeCase(string: string): string;
+export declare function toSnakeCase(string: string): string;
 /**
  * Transform the first letter of the given string to the upper case
  *
  * @param string
  * @return string
  */
-declare function capitalize(string: string): string;
+export declare function capitalize(string: string): string;
 /**
  * Registry independent string sorting
  *
  * @param first
  * @param second
  */
-declare function sortByAlphabet(first: string, second: string): number;
+export declare function sortByAlphabet(first: string, second: string): number;
 /**
  * @param length
  * @return string of max length 100
  */
-declare function getRandomStr(length?: number): string;
-declare function getRandomItem(items: any[]): any;
+export declare function getRandomStr(length?: number): string;
+export declare function getRandomItem(items: any[]): any;
 /**
  * Summarize elements of the given array
  *
@@ -184,36 +167,32 @@ declare function getRandomItem(items: any[]): any;
  * @return number | string - a summary of all the numbers in the array or an empty string if
  * there was only NaNs
  */
-declare function sumArray(values: Array<any>): number | string;
+export declare function sumArray(values: Array<any>): number | string;
 /**
  * Returns an array of the object keys which values are not present in filter
  *
  * @param obj
  * @param values
  */
-declare function filterObjectKeysByValues(obj: {
+export declare function filterObjectKeysByValues(obj: {
     [key: string]: any;
 }, values: Array<string | number | boolean | null | undefined>): string[];
-declare function getFromObject(object: object, key: string): any;
-declare function fireBlurEvent(element: string | Element | null, delay?: number): void;
-declare function fireInputEvent(element: string | Element | null, delay?: number): void;
-declare function fireEvent(eventName: string, element: string | Element | null, delay?: number): void;
-declare function hasObjectChanged(object: {
-    [key: string]: any;
-}, values: any[]): boolean;
-declare function roundBigNum(number: number): number;
-declare function extractNumbers(value: any): string;
-declare function removeSpaces(value: any): string;
-declare function roundUp(num: number, precision: number): number;
-declare function roundDown(num: number, precision: number): number;
-declare function areDiff(val1?: Primitive | null, val2?: Primitive | null, strict?: boolean): boolean;
-declare function flattenObject(obj: FlattenableObject, prefix?: string): FlattenableObject;
-declare function flattenObjectAsArray(obj: FlattenableObject): FlattenableObject;
-declare function parseObjectPathStr(pathStr: string): string[];
-declare function formatNumber(num: number | string, fractionDigits?: number): string;
-declare function formatNumberWithSign(num: number | string, fractionDigits?: number): string;
-declare function formatPercent(num: number | string): string;
-declare function formatWithSign(num: number | string, numString?: string): string;
-declare function autoSizeText(el: HTMLElement, height: number, minFontSize: number, maxFontSize?: number): void;
-
-export { areDiff, arrayDiff, arrayIntersect, autoSizeText, capitalize, countObjectInnerLength, createHtmlElement, createLinkElement, createPixelElement, createScriptElement, createStyleElement, createSvgElement, debounce, decodeSafeURL, deepCloneObject, encodeQueryString, extractNumbers, filterObjectKeysByValues, fireBlurEvent, fireEvent, fireInputEvent, flatHtmlAttributes, flattenObject, flattenObjectAsArray, formatNumber, formatNumberWithSign, formatPercent, formatWithSign, getFromObject, getHtmlElement, getNumericStyleProp, getObjectKeys, getRandomInt, getRandomItem, getRandomStr, getSafeURL, getScreenSize, hasObjectChanged, hashCode, injectScript, injectStyleLink, insertCss, insertHtmlElements, insertJs, isBool, isDefined, isElementVisible, isFn, isHTMLElement, isNotEmptyString, isNullOrUndef, isNum, isObject, isStr, isString, isUndef, objectHasProp, objectToQueryString, onDOMReady, parseObjectPathStr, parseURL, removeSpaces, roundBigNum, roundDown, roundUp, sortByAlphabet, stringToHtmlElements, sumArray, throttle, toBinaryStr, toCamelCase, toPercent, toSnakeCase };
+export declare function getFromObject(object: object, key: string): any;
+export declare function fireBlurEvent(element: string | Element | null, delay?: number): void;
+export declare function fireInputEvent(element: string | Element | null, delay?: number): void;
+export declare function fireEvent(eventName: string, element: string | Element | null, delay?: number): void;
+export declare function hasObjectChanged(oldObj: Record<string, any>, values: [string, any][], checkNewKeys?: boolean): boolean;
+export declare function roundBigNum(number: number): number;
+export declare function extractNumbers(value: unknown): string;
+export declare function removeSpaces(value: unknown): string;
+export declare function roundUp(num: number, precision: number): number;
+export declare function roundDown(num: number, precision: number): number;
+export declare function areDiff(val1?: Primitive | null, val2?: Primitive | null, strict?: boolean): boolean;
+export declare function flattenObject(obj: Record<string, any>, prefix?: string): Record<string, any>;
+export declare function flattenObjectAsArray(obj: Record<string, any>): Record<string, any>;
+export declare function parseObjectPathStr(pathStr: string): string[];
+export declare function formatNumber(num: number | string, fractionDigits?: number): string;
+export declare function formatNumberWithSign(num: number | string, fractionDigits?: number): string;
+export declare function formatPercent(num: number | string): string;
+export declare function formatWithSign(num: number | string, numString?: string): string;
+export declare function autoSizeText(el: HTMLElement, height: number, minFontSize: number, maxFontSize?: number): void;