@creopse/utils 0.0.1

package/dist/utils/functions.d.ts

@@ -0,0 +1,312 @@
+/**
+ * Generates the initials of a given name.
+ *
+ * @param {string} name - The name to generate the initials from.
+ * @return {string} The initials of the given name.
+ */
+export declare function getNameInitials(name: string): string;
+/**
+ * Generates a random integer between the provided minimum and maximum values (inclusive).
+ *
+ * @param {number} min - The minimum value for the random integer.
+ * @param {number} max - The maximum value for the random integer.
+ * @return {number} The randomly generated integer.
+ */
+export declare function getRandomInteger(min: number, max: number): number;
+/**
+ * Removes the trailing slash from a given path.
+ *
+ * @param {string} path - The path to remove the trailing slash from.
+ * @return {string} The path without the trailing slash.
+ */
+export declare function removeTrailingSlash(path: string): string;
+/**
+ * Removes the leading slash from a path if it starts with a slash.
+ *
+ * @param {string} path - The path from which to remove the leading slash.
+ * @return {string} The path without the leading slash.
+ */
+export declare function removeLeadingSlash(path: string): string;
+/**
+ * Calculates the distance between two points on the Earth's surface using the Haversine formula.
+ *
+ * @param {number} lat1 - The latitude of the first point.
+ * @param {number} lon1 - The longitude of the first point.
+ * @param {number} lat2 - The latitude of the second point.
+ * @param {number} lon2 - The longitude of the second point.
+ * @return {number} The distance between the two points in kilometers.
+ */
+export declare function getDistanceFromLatLonInKm(lat1: number, lon1: number, lat2: number, lon2: number): number;
+/**
+ * Converts degrees to radians.
+ *
+ * @param {number} deg - The angle in degrees.
+ * @returns {number} The angle in radians.
+ */
+export declare function deg2rad(deg: number): number;
+/**
+ * Checks if the given path is an external URL, email address, or phone number.
+ *
+ * @param {string} path - The path to check.
+ * @return {boolean} Returns true if the path is external, false otherwise.
+ */
+export declare function isExternal(path: string): boolean;
+/**
+ * Formats the given duration in seconds into a string representation of time.
+ *
+ * @param {number} duration - The duration in seconds to be formatted.
+ * @param {Object} options - Optional parameters for formatting.
+ * @param {string} options.separator - The separator used between hours, minutes, and seconds. Defaults to ':'.
+ * @return {string} - The formatted time string.
+ */
+export declare function formatTimeFromSeconds(duration: number, { separator }?: {
+    separator?: string | undefined;
+}): string;
+/**
+ * Pads the left side of a string with a specified character until it reaches a specified length.
+ *
+ * @param {string} string - The string to be padded.
+ * @param {string} pad - The character used for padding.
+ * @param {number} length - The desired length of the resulting string.
+ * @return {string} The padded string.
+ */
+export declare function strPadLeft(string: string, pad: string, length: number): string;
+/**
+ * Capitalizes the first letter of a given string.
+ *
+ * @param {string} string - The string to capitalize.
+ * @return {string} The modified string with the first letter capitalized.
+ */
+export declare function capitalizeFirstLetter(string: string): string;
+/**
+ * Generates a password with the specified length and character options.
+ *
+ * @param {number} length - The length of the password to be generated. Default is 10.
+ * @param {object} options - The character options for the password. Default is { letters: true, numbers: true, symbols: false }.
+ * @param {boolean} options.letters - Specifies whether to include letters in the password. Default is true.
+ * @param {boolean} options.numbers - Specifies whether to include numbers in the password. Default is true.
+ * @param {boolean} options.symbols - Specifies whether to include symbols in the password. Default is false.
+ * @return {string} The generated password.
+ */
+export declare function genPassword(length?: number, { letters, numbers, symbols }?: {
+    letters?: boolean | undefined;
+    numbers?: boolean | undefined;
+    symbols?: boolean | undefined;
+}): string;
+/**
+ * Extracts uppercase words from the given input string.
+ *
+ * @param {string} input - The input string to extract uppercase words from.
+ * @return {Array<string>} An array of uppercase words found in the input string.
+ */
+export declare function extractUppercaseWords(input: string): RegExpMatchArray | null;
+/**
+ * Extracts lowercase words from the input string.
+ *
+ * @param {string} input - The string to extract lowercase words from.
+ * @return {string[]} An array of lowercase words extracted from the input string.
+ */
+export declare function extractLowercaseWords(input: string): RegExpMatchArray | null;
+/**
+ * Generates a random color code in hexadecimal format.
+ *
+ * @return {string} The randomly generated color code.
+ */
+export declare function genRandomColor(): string;
+/**
+ * Converts a data URL to a Blob object.
+ *
+ * @param {string} dataUrl - The data URL to be converted.
+ * @return {Blob} The resulting Blob object.
+ */
+export declare function dataUrlToBlob(dataUrl: string): Blob;
+/**
+ * Converts a data URL to a File object.
+ *
+ * @param {string} dataUrl - The data URL to convert.
+ * @param {Object} options - Optional parameters.
+ * @param {string} options.fileName - The name of the file. Default is 'file.png'.
+ * @param {string} options.type - The MIME type of the file. Default is 'image/png'.
+ * @returns {File} The converted File object.
+ */
+export declare function dataUrlToFile(dataUrl: string, { fileName, type, }?: {
+    fileName?: string;
+    type?: string;
+}): File;
+/**
+ * Creates a new array of pure JavaScript objects by making a shallow copy of each object in the input array.
+ *
+ * @param {Array<object>} array - The input array containing objects to be copied.
+ * @return {Array<object>} A new array containing the copied objects.
+ */
+export declare function toArrayOfPureJsObjects(array: Array<object>): object[];
+/**
+ * Converts a number of bytes to a human-readable file size.
+ *
+ * @param {number} bytes - The number of bytes to convert.
+ * @param {boolean} si - Whether to use the SI units (1000) or binary units (1024).
+ * @param {number} dp - The number of decimal places to round the result to.
+ * @return {string} The human-readable file size.
+ */
+export declare function humanFileSize(bytes: number, si?: boolean, dp?: number): string;
+/**
+ * Returns the filename from a given URL.
+ *
+ * @param {string} url - The URL from which to extract the filename.
+ * @return {string} The filename extracted from the URL.
+ */
+export declare function filenameFromUrl(url: string): string;
+/**
+ * Downloads a file by URL.
+ *
+ * @param {string} url - The URL of the file to be downloaded.
+ */
+export declare function downloadByUrl(url: string): void;
+/**
+ * Downloads the given object as a JSON file with the specified name.
+ *
+ * @param {object} exportObj - The object to be exported as JSON.
+ * @param {string} exportName - The name of the exported file.
+ * @return {void} This function does not return a value.
+ */
+export declare function downloadObjectAsJson(exportObj: object, exportName: string): void;
+/**
+ * Parses an INI string and returns an object containing the key-value pairs.
+ *
+ * @param {string} iniString - The INI string to parse.
+ * @return {{ [key: string]: string }} - An object containing the key-value pairs parsed from the INI string.
+ */
+export declare function parseINIString(iniString: string): {
+    [key: string]: string;
+};
+/**
+ * Compresses an image file.
+ *
+ * @param {File} file - The image file to compress.
+ * @param {Object} options - Optional parameters for compression.
+ * @param {number} options.maxSizeMB - The maximum size of the compressed image file in megabytes (default is 1MB).
+ * @param {number} options.maxWidthOrHeight - The maximum width or height of the compressed image file in pixels (default is 1920).
+ * @return {Promise<File>} The compressed image file.
+ */
+export declare function compressImage(file: File, { maxSizeMB, maxWidthOrHeight }?: {
+    maxSizeMB?: number | undefined;
+    maxWidthOrHeight?: number | undefined;
+}): Promise<File>;
+/**
+ * Returns the base URL of the current window location.
+ *
+ * @return {string} The base URL of the current window location.
+ */
+export declare function getBaseUrl(): string;
+/**
+ * Returns the URL of the current page by appending the base URL with the pathname.
+ *
+ * @return {string} The URL of the current page.
+ */
+export declare function getPageUrl(): string;
+/**
+ * Generates a function comment for the given function body in a markdown code block with the correct language syntax.
+ *
+ * @param {string} url - the URL to open in the new window
+ * @param {Array<string>} data - an array of strings containing the data to be sent to the server
+ * @param {Object} options - an optional object containing target and method properties
+ * @param {string} options.target - the target attribute for the form submission (default: '_self')
+ * @param {string} options.method - the method attribute for the form submission (default: 'POST')
+ * @return {void} This function does not return anything
+ */
+export declare function openWindowWithJS(url: string, data: {
+    [key: string]: string;
+}, { target, method }?: {
+    target?: string | undefined;
+    method?: string | undefined;
+}): void;
+/**
+ * Loads the metadata of an image from the specified URL.
+ *
+ * @param {string} url - The URL of the image.
+ * @return {Promise<Image>} A promise that resolves with the loaded image.
+ */
+export declare function loadImageMeta(url: string): Promise<unknown>;
+/**
+ * Abbreviates a number by adding a suffix representing the magnitude.
+ *
+ * @param {number} number - The number to be abbreviated.
+ * @return {string} The abbreviated number with the magnitude suffix.
+ */
+export declare function abbreviateNumber(number: number): string | number;
+/**
+ * Extracts numbers from a given string.
+ *
+ * @param {string} string - The string from which to extract numbers.
+ * @param {object} options - Optional parameters for customization.
+ * @param {boolean} options.array - Whether to return an array of numbers. Defaults to false.
+ * @param {boolean} options.float - Whether to include floating-point numbers. Defaults to true.
+ * @return {number|array} - The extracted number(s) from the string. If options.array is true, an array will be returned. Otherwise, a single number will be returned.
+ */
+export declare function extractNumber(string: string, { array, float }?: {
+    array?: boolean | undefined;
+    float?: boolean | undefined;
+}): number | number[];
+/**
+ * Extracts all alphabetic characters from a given string.
+ *
+ * @param {string} string - The input string.
+ * @param {Object} options - Optional parameters.
+ * @param {boolean} options.array - Whether to return the result as an array. Default is false.
+ * @return {string | string[]} - The extracted alphabetic characters, either as a string or an array.
+ */
+export declare function extractAlphabet(string: string, { array }?: {
+    array?: boolean | undefined;
+}): string | string[];
+/**
+ * Removes the specified searchString from the given str.
+ *
+ * @param {string} str - The original string.
+ * @param {string} searchString - The string to be removed from str.
+ * @return {string} The modified string with the searchString removed.
+ */
+export declare function removeFromString(str: string, searchString: string): string;
+/**
+ * Replaces multiple parts of a string based on a given set of replacements.
+ *
+ * @param {string} inputString - The original string to be modified.
+ * @param {Record<string, string>} replacements - An object containing key-value pairs where the key is the part to be replaced and the value is the replacement string.
+ * @return {string} - The modified string with all occurrences of the specified parts replaced.
+ */
+export declare function replaceStringParts(inputString: string, replacements: Record<string, string>): string;
+/**
+ * Generates a custom ID of the specified length.
+ *
+ * @param {number} length - The length of the ID to be generated.
+ * @return {string} The custom ID.
+ */
+export declare function generateCustomId(length: number): string;
+/**
+ * Removes duplicate elements from an array based on a specified property.
+ *
+ * @param {T[]} arr - The array from which duplicate elements will be removed.
+ * @param {keyof T} property - The property used to determine duplicates.
+ * @returns {T[]} The array with duplicate elements removed.
+ */
+export declare function removeDuplicates<T>(arr: T[], property: keyof T): T[];
+/**
+ * Converts a hexadecimal color code to an RGBA color with the specified alpha value.
+ *
+ * @param {string} hex - the hexadecimal color code
+ * @param {number} alpha - the alpha value for the RGBA color
+ * @return {string} the RGBA color code
+ */
+export declare function hexToRgba(hex: string, alpha: number): string;
+/**
+ * Shuffles the elements in an array in place using the Fisher-Yates algorithm.
+ *
+ * @param {T[]} array - The array to be shuffled.
+ * @return {T[]} The shuffled array.
+ */
+export declare function shuffleArray<T>(array: T[]): T[];
+/**
+ * Scrolls to the element with the specified ID, with a smooth animation.
+ *
+ * @param {string} id - The ID of the element to scroll to.
+ */
+export declare function slideToId(id: string): void;