@ztimson/utils 0.15.6 → 0.16.0

package/dist/string.d.ts

@@ -1,12 +1,30 @@
-export declare function countChars(text: string, pattern: RegExp): number;
-export declare function createHex(length: number): string;
+/**
+ * Generate a random hexadecimal value
+ *
+ * @param {number} length Number of hexadecimal place values
+ * @return {string} Hexadecimal number as a string
+ */
+export declare function randomHex(length: number): string;
+/**
+ * Convert number of bytes into a human-readable size
+ *
+ * @param {number} bytes Number of bytes
+ * @param {number} decimals Decimal places to preserve
+ * @return {string} Formated size
+ */
 export declare function formatBytes(bytes: number, decimals?: number): string;
+/**
+ * Extract numbers from a string & create a formated phone number: +1 (123) 456-7890
+ *
+ * @param {string} number String that will be parsed for numbers
+ * @return {string} Formated phone number
+ */
 export declare function formatPhoneNumber(number: string): string;
 /**
  * Insert a string into another string at a given position
  *
  * @example
- * ```
+ * ```js
  * console.log(insertAt('Hello world!', ' glorious', 5);
  * // Output: Hello glorious world!
  * ```
@@ -17,7 +35,24 @@ export declare function formatPhoneNumber(number: string): string;
  * @returns {string} - New string
  */
 export declare function insertAt(target: string, str: string, index: number): String;
-export declare function pad(text: any, length: number, char: string, start?: boolean): any;
+/**
+ * Add padding to string
+ *
+ * @example
+ * ```js
+ * const now = new Date();
+ * const padded = now.getHours() + ':' + pad(now.getMinutes(), 2, '0');
+ * console.log(padded); // Output: "2:05"
+ * ```
+ *
+ * @param text Text that will be padded
+ * @param {number} length Target length
+ * @param {string} char Character to use as padding, defaults to space
+ * @param {boolean} start Will pad start of text if true, or the end if false
+ * @return {string} Padded string
+ * @deprecated Please use `String.padStart` & `String.padEnd`
+ */
+export declare function pad(text: any, length: number, char?: string, start?: boolean): any;
 /**
  * Generate a string of random characters.
  *
@@ -58,8 +93,29 @@ export declare function randomStringBuilder(length: number, letters?: boolean, n
  * @return {RegExpExecArray[]} Found matches.
  */
 export declare function matchAll(value: string, regex: RegExp | string): RegExpExecArray[];
+/** Parts of a URL */
+export type ParsedUrl = {
+    protocol?: string;
+    subdomain?: string;
+    domain: string;
+    host: string;
+    port?: number;
+    path?: string;
+    query?: {
+        [name: string]: string;
+    };
+    fragment?: string;
+};
+/**
+ * Break a URL string into its parts for easy parsing
+ *
+ * @param {string} url URL string that will be parsed
+ * @returns {RegExpExecArray} Parts of URL
+ */
+export declare function parseUrl(url: string): ParsedUrl;
 /**
  * Create MD5 hash using native javascript
+ *
  * @param d String to hash
  * @returns {string} Hashed string
  */

package/dist/time.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Return date formated highest to lowest: YYYY-MM-DD H:mm AM
+ *
+ * @param {Date | number | string} date Date or timestamp to convert to string
+ * @return {string} Formated date
+ */
 export declare function formatDate(date: Date | number | string): string;
 /**
  * Use in conjunction with `await` to pause an async script
@@ -6,6 +12,7 @@ export declare function formatDate(date: Date | number | string): string;
  * ```js
  * await sleep(1000) // Pause for 1 second
  * ```
+ *
  * @param {number} ms - Time to pause for in milliseconds
  * @returns {Promise<unknown>} - Resolves promise when it's time to resume
  */
@@ -19,6 +26,7 @@ export declare function sleep(ms: number): Promise<void>;
  * setTimeout(() => wait = false, 1000);
  * await sleepUntil(() => loading); // Won't continue until loading flag is false
  * ```
+ *
  * @param {() => boolean} fn Return true to continue
  * @param {number} checkInterval Run function ever x milliseconds
  * @return {Promise<void>} Callback when sleep is over

package/dist/types.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Return keys on a type as an array of strings
+ *
+ * @example
+ * ```ts
+ * type Person = {
+ * 	  firstName: string;
+ * 	  lastName: string;
+ * 	  age: number;
+ * }
+ *
+ * const keys = typeKeys<Person>();
+ * console.log(keys); // Output: ["firstName", "lastName", "age"]
+ * ```
+ *
+ * @return {Array<keyof T>} Available keys
+ */
+export declare function tyoeKeys<T extends object>(): (keyof T)[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.15.6",
+	"version": "0.16.0",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
@@ -21,6 +21,7 @@
 	},
 	"scripts": {
 		"build": "npx tsc && npx vite build",
+		"docs": "typedoc --plugin typedoc-plugin-markdown --cleanOutputDir false --outputFileStrategy modules --hidePageHeader --out ./docs --entryPoints src/**/*.ts --readme none --entryFileName Home",
 		"test": "npx jest",
 		"test:coverage": "npx jest --coverage",
 		"watch": "npx vite build --watch"
@@ -30,6 +31,8 @@
 		"jest": "^29.7.0",
 		"jest-junit": "^16.0.0",
 		"ts-jest": "^29.1.2",
+		"typedoc": "^0.26.7",
+		"typedoc-plugin-markdown": "^4.2.7",
 		"typescript": "^5.3.3",
 		"vite": "^5.0.12",
 		"vite-plugin-dts": "^3.7.2"