@capsitech/react-utilities 0.1.4 → 0.1.6

package/lib/Utilities/Types.d.ts

@@ -1,19 +1,19 @@
-export interface IId<TId = string> {
-    id: TId;
-}
-export interface IIdName<TId = string> extends IId<TId> {
-    name: string;
-}
-export interface IAddress {
-    building: string;
-    street: string;
-    city: string;
-    county: string;
-    postcode: string;
-    country: string;
-}
-export interface IRecordUpdateInfo {
-    userId: string;
-    userName: string;
-    date: Date;
-}
+export interface IId<TId = string> {
+    id: TId;
+}
+export interface IIdName<TId = string> extends IId<TId> {
+    name: string;
+}
+export interface IAddress {
+    building: string;
+    street: string;
+    city: string;
+    county: string;
+    postcode: string;
+    country: string;
+}
+export interface IRecordUpdateInfo {
+    userId: string;
+    userName: string;
+    date: Date;
+}

package/lib/Utilities/Types.js

@@ -1 +1 @@
-export {};
+export {};

package/lib/Utilities/Utils.d.ts

@@ -1,174 +1,174 @@
-import { Dayjs } from 'dayjs';
-import React from 'react';
-import { IAddress } from './Types';
-export declare const StorageMessageKey = "ao-message";
-export interface IStorageMessage extends Record<string, any> {
-    type: string;
-    t: string;
-    domain: string;
-}
-export interface IFormattedNumberOptions {
-    decimalPlaces?: number;
-    withComma?: boolean;
-    useDashForZero?: boolean;
-}
-declare class UtilsBase {
-    DateRegEx: RegExp;
-    NiNoRegEx: RegExp;
-    /**
-     * Unique id for the tab (openned browser tab)
-     */
-    TabIdKey: string;
-    constructor();
-    /**
-     * Get number from any type/value
-     * @param num Value to get number
-     */
-    getNumber: (num?: string | number) => number;
-    /**
-     * Get formatted date in DD/MM/YYYY hh:mm A or DD/MM/YYYY
-     * @param date Date to be formatted
-     * @param emptyValue Value to return if date is empty or null
-     * @param withTime Return date with time
-     */
-    getFormattedDate: (date: string | number | Date | Dayjs | undefined, emptyValue?: string, withTime?: boolean, timeZone?: string) => string | undefined;
-    /**
-     * Get formatted number
-     * @param number Number to format
-     * @param decimalPlaces Number of decimal places
-     * @param withComma Get number with separator
-     * @param useDashForZero Use dash for zero
-     * @param withCurrency Prepend £ before number
-     */
-    getFormattedNumber: (number: any, decimalPlaces?: number, withComma?: boolean, useDashForZero?: boolean, withCurrency?: boolean) => string;
-    /**
-     * Get formatted number
-     * @param number Number to format
-     * @param useDashForZero Use dash for zero
-     */
-    getFormattedCurrency: (number: any, useDashForZero?: boolean) => string;
-    /**
-     * Append zero if number is less then 10
-     * @param num Number to check
-     */
-    appendZero: (num: number) => string | number;
-    /**
-     * Get formatted time (MM:SS)
-     * @param seconds Seconds - to get time
-     * @param minutes Minutes - to get time
-     */
-    getFormattedTime: (seconds: number, minutes?: number) => string;
-    /**
-     * Get formatted time from total seconds
-     * @param seconds Total seconds to calculate hours and minutes
-     * @param ignoreSeconds Skip seconds in output string
-     */
-    getFormattedSeconds: (seconds: number, ignoreSeconds?: boolean) => string;
-    /**
-     * Get a property value from local storage
-     * @param {string} Key name to find the value
-     */
-    getLocal: (key: string) => any;
-    /**
-     * Set a property with value to local storage
-     * @param {string} Key name to find the value
-     * @param {any} data Data/value to be stored
-     */
-    setLocal: (key: string, data: any) => void;
-    /**
-     * Remove a property with value from local storage
-     * @param {string} Key name to find the value
-     */
-    removeLocal: (key: string) => void;
-    /**
-     * Get a property value from session storage
-     * @param {string} Key name to find the value
-     */
-    getSession: (key: string) => any;
-    /**
-     * Set a property with value to session storage
-     * @param {string} Key name to find the value
-     * @param {any} data Data/value to be stored
-     */
-    setSession: (key: string, data: any) => void;
-    jsonReplacer: (key: string, value: any) => any;
-    /**
-     * Get file size in kb/mb/gb etc.
-     * @param {number} size File lenth/size
-     */
-    getFileSize: (size: number) => string;
-    /**
-     * A custom hook that builds on useLocation to parse the query string for you.
-     */
-    useQuery: () => URLSearchParams;
-    /**
-     * Sum number array
-     * @param {number[]} arr Number array
-     */
-    sumArray: (arr: number[]) => number;
-    /**
-     * Get sorted array by property
-     * @param {any[]} arr Array of objects
-     * @param {string} key Property/field name to sort
-     * @returns {any[]}
-     */
-    sortArray<T = any>(arr: T[], key: keyof T): T[];
-    /**
-     * Replace an item in array with index
-     * @param arr Array of objects
-     * @param index Index where to replace the item
-     * @param newValue New item to be replaced with
-     * @returns Array of objects
-     */
-    replaceItemAtIndex<T = any>(arr: T[], index: number, newValue: T): T[];
-    /**
-     * Remove an item from array with index
-     * @param arr Array of objects
-     * @param index Index which item to be removed
-     * @returns Array of object
-     */
-    removeItemAtIndex<T = any>(arr: T[], index: number): T[];
-    /**
-     * Capitalize the words of a string
-     * @param {string} value String or value to be capitalized
-     * @param {boolean} lower To lowercase other chars
-     */
-    capitalize: (value: string | null | undefined, lower?: boolean) => string;
-    /**
-     * Validate current MongoDB ObjectId
-     * @param id Id to check for ObjectId
-     */
-    isValidObjectId: (id?: string) => boolean;
-    /**
-     * Set a property with value to local storage and then remove imidiatly, it is usefull to send message to all opened tabs
-     * @param {string} Key name to find the value
-     * @param {any} data Data/value to be stored
-     */
-    sendMessageToAllTabs: (type: string, data?: any) => void;
-    /**
-     * Check and get new event message, from event object
-     * @param {StorageEvent} event Event object received in storage event listener
-     */
-    getStorageMessage: (event: StorageEvent) => IStorageMessage | null;
-    /**
-     * Assign value to an object by key/path name
-     * @param obj Object to assign value to
-     * @param path key full path
-     * @param val value to be assigned
-     * @param separator Path separator
-     */
-    setNestedKeyValue: (obj: any, path: string, val: any, separator?: string) => void;
-    /**
-     * Get comma separated address string
-     * @param address address object to be converted
-     */
-    getAddressString: (address?: IAddress, emptyString?: string) => string;
-    /**
-     * Get new random UUID
-     * @returns {string}
-     */
-    uuid: () => string;
-}
-export declare const Utils: UtilsBase;
-export declare function useIsMountedRef(): React.MutableRefObject<boolean | null>;
-export {};
+import { Dayjs } from 'dayjs';
+import React from 'react';
+import { IAddress } from './Types';
+export declare const StorageMessageKey = "ao-message";
+export interface IStorageMessage extends Record<string, any> {
+    type: string;
+    t: string;
+    domain: string;
+}
+export interface IFormattedNumberOptions {
+    decimalPlaces?: number;
+    withComma?: boolean;
+    useDashForZero?: boolean;
+}
+declare class UtilsBase {
+    DateRegEx: RegExp;
+    NiNoRegEx: RegExp;
+    /**
+     * Unique id for the tab (openned browser tab)
+     */
+    TabIdKey: string;
+    constructor();
+    /**
+     * Get number from any type/value
+     * @param num Value to get number
+     */
+    getNumber: (num?: string | number) => number;
+    /**
+     * Get formatted date in DD/MM/YYYY hh:mm A or DD/MM/YYYY
+     * @param date Date to be formatted
+     * @param emptyValue Value to return if date is empty or null
+     * @param withTime Return date with time
+     */
+    getFormattedDate: (date: string | number | Date | Dayjs | undefined, emptyValue?: string, withTime?: boolean, timeZone?: string) => string | undefined;
+    /**
+     * Get formatted number
+     * @param number Number to format
+     * @param decimalPlaces Number of decimal places
+     * @param withComma Get number with separator
+     * @param useDashForZero Use dash for zero
+     * @param withCurrency Prepend £ before number
+     */
+    getFormattedNumber: (number: any, decimalPlaces?: number, withComma?: boolean, useDashForZero?: boolean, withCurrency?: boolean) => string;
+    /**
+     * Get formatted number
+     * @param number Number to format
+     * @param useDashForZero Use dash for zero
+     */
+    getFormattedCurrency: (number: any, useDashForZero?: boolean) => string;
+    /**
+     * Append zero if number is less then 10
+     * @param num Number to check
+     */
+    appendZero: (num: number) => string | number;
+    /**
+     * Get formatted time (MM:SS)
+     * @param seconds Seconds - to get time
+     * @param minutes Minutes - to get time
+     */
+    getFormattedTime: (seconds: number, minutes?: number) => string;
+    /**
+     * Get formatted time from total seconds
+     * @param seconds Total seconds to calculate hours and minutes
+     * @param ignoreSeconds Skip seconds in output string
+     */
+    getFormattedSeconds: (seconds: number, ignoreSeconds?: boolean) => string;
+    /**
+     * Get a property value from local storage
+     * @param {string} Key name to find the value
+     */
+    getLocal: (key: string) => any;
+    /**
+     * Set a property with value to local storage
+     * @param {string} Key name to find the value
+     * @param {any} data Data/value to be stored
+     */
+    setLocal: (key: string, data: any) => void;
+    /**
+     * Remove a property with value from local storage
+     * @param {string} Key name to find the value
+     */
+    removeLocal: (key: string) => void;
+    /**
+     * Get a property value from session storage
+     * @param {string} Key name to find the value
+     */
+    getSession: (key: string) => any;
+    /**
+     * Set a property with value to session storage
+     * @param {string} Key name to find the value
+     * @param {any} data Data/value to be stored
+     */
+    setSession: (key: string, data: any) => void;
+    jsonReplacer: (key: string, value: any) => any;
+    /**
+     * Get file size in kb/mb/gb etc.
+     * @param {number} size File lenth/size
+     */
+    getFileSize: (size: number) => string;
+    /**
+     * A custom hook that builds on useLocation to parse the query string for you.
+     */
+    useQuery: () => URLSearchParams;
+    /**
+     * Sum number array
+     * @param {number[]} arr Number array
+     */
+    sumArray: (arr: number[]) => number;
+    /**
+     * Get sorted array by property
+     * @param {any[]} arr Array of objects
+     * @param {string} key Property/field name to sort
+     * @returns {any[]}
+     */
+    sortArray<T = any>(arr: T[], key: keyof T): T[];
+    /**
+     * Replace an item in array with index
+     * @param arr Array of objects
+     * @param index Index where to replace the item
+     * @param newValue New item to be replaced with
+     * @returns Array of objects
+     */
+    replaceItemAtIndex<T = any>(arr: T[], index: number, newValue: T): T[];
+    /**
+     * Remove an item from array with index
+     * @param arr Array of objects
+     * @param index Index which item to be removed
+     * @returns Array of object
+     */
+    removeItemAtIndex<T = any>(arr: T[], index: number): T[];
+    /**
+     * Capitalize the words of a string
+     * @param {string} value String or value to be capitalized
+     * @param {boolean} lower To lowercase other chars
+     */
+    capitalize: (value: string | null | undefined, lower?: boolean) => string;
+    /**
+     * Validate current MongoDB ObjectId
+     * @param id Id to check for ObjectId
+     */
+    isValidObjectId: (id?: string) => boolean;
+    /**
+     * Set a property with value to local storage and then remove imidiatly, it is usefull to send message to all opened tabs
+     * @param {string} Key name to find the value
+     * @param {any} data Data/value to be stored
+     */
+    sendMessageToAllTabs: (type: string, data?: any) => void;
+    /**
+     * Check and get new event message, from event object
+     * @param {StorageEvent} event Event object received in storage event listener
+     */
+    getStorageMessage: (event: StorageEvent) => IStorageMessage | null;
+    /**
+     * Assign value to an object by key/path name
+     * @param obj Object to assign value to
+     * @param path key full path
+     * @param val value to be assigned
+     * @param separator Path separator
+     */
+    setNestedKeyValue: (obj: any, path: string, val: any, separator?: string) => void;
+    /**
+     * Get comma separated address string
+     * @param address address object to be converted
+     */
+    getAddressString: (address?: IAddress, emptyString?: string) => string;
+    /**
+     * Get new random UUID
+     * @returns {string}
+     */
+    uuid: () => string;
+}
+export declare const Utils: UtilsBase;
+export declare function useIsMountedRef(): React.MutableRefObject<boolean | null>;
+export {};