Updated docs

.github/workflows/build.yaml

@@ -48,3 +48,13 @@ jobs:
           uses: ztimson/actions/tag@develop
           with:
             tag: ${{env.VERSION}}
+
+
+  docs:
+    name: Publish Documentation
+    needs: build
+    uses: ztimson/actions/.github/workflows/docker.yaml@develop
+    with:
+        name: ztimson/utils
+        repository: ${{github.server_url}}/${{github.repository}}.git
+        pass: ${{secrets.DEPLOY_TOKEN}}

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "docs"]
+	path = docs
+	url = git@git.zakscode.com:ztimson/utils.wiki.git
+	branch = master
+	ignore = all

Dockerfile

@@ -0,0 +1,13 @@
+# Build application
+FROM node:alpine as build
+
+RUN mkdir /app
+WORKDIR /app
+COPY . .
+RUN if [ ! -d "node_modules" ]; then npm i; fi && \
+    if [ ! -d "dist" ]; then npm run docs; fi
+
+# Use Nginx to serve
+FROM nginx:1.23-alpine
+
+COPY --from=build /app/docs /usr/share/nginx/html

README.md

@@ -0,0 +1,91 @@
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/77dbab78e5fb3302dc9e751c4d6315a64df8d3a714d5cd5719b0dc39e6619119" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+### @ztimson/utils
+
+  <!-- Description -->
+Javascript/Typescript Utilities
+
+  <!-- Repo badges -->
+[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils/tags&query=$[0].name)](https://git.zakscode.com/ztimson/utils/tags)
+[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_pr_counter)](https://git.zakscode.com/ztimson/utils/pulls)
+[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_issues_count)](https://git.zakscode.com/ztimson/utils/issues)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://utils.docs.zakscode.com" target="_blank">Documentation</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [@ztimson/utils](#top)
+	- [About](#about)
+		- [Built With](#built-with)
+	- [Setup](#setup)
+		- [Production](#production)
+		- [Development](#development)
+	- [Documentation](https://utils.docs.zakscode.com/)
+	- [License](#license)
+
+## About
+
+A collection of utilities to make life a little easier
+
+### Built With
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="production" style="display: inline">
+    Production
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install persist: `npm i @ztimosn/utils`
+
+</details>
+
+<details>
+<summary>
+  <h3 id="development" style="display: inline">
+    Development
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install the dependencies: `npm i`
+2. Build library: `npm build`
+3. Run unit tests: `npm test`
+
+</details>
+
+## Documentation
+
+[Available Here](https://utils.docs.zakscode.com/)
+
+## License
+
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](_media/LICENSE) for more information.

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.15.6",
+	"version": "0.17.1",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
@@ -21,6 +21,7 @@
 	},
 	"scripts": {
 		"build": "npx tsc && npx vite build",
+		"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
 		"test": "npx jest",
 		"test:coverage": "npx jest --coverage",
 		"watch": "npx vite build --watch"
@@ -30,11 +31,15 @@
 		"jest": "^29.7.0",
 		"jest-junit": "^16.0.0",
 		"ts-jest": "^29.1.2",
+		"typedoc": "^0.26.7",
 		"typescript": "^5.3.3",
 		"vite": "^5.0.12",
 		"vite-plugin-dts": "^3.7.2"
 	},
 	"files": [
 		"dist"
-	]
+	],
+	"dependencies": {
+		"var-persist": "^1.0.1"
+	}
 }

src/array.ts

@@ -1,10 +1,32 @@
 import {dotNotation, isEqual} from './objects';
 
+/**
+ * Only add element to array if it isn't already included
+ *
+ * @example
+ * ```js
+ * const arr = addUnique([1, 2, 3], 3);
+ * console.log(arr); // Output: [1, 2, 3]
+ * ```
+ *
+ * @param {T[]} array Target array element will be added to
+ * @param {T} el Unique element to add
+ * @return {T[]} Array with element if it was unique
+ * @deprecated Use ASet to create unique arrays
+ */
 export function addUnique<T>(array: T[], el: T): T[] {
 	if(array.indexOf(el) === -1) array.push(el);
 	return array;
 }
 
+/**
+ * Find all unique elements in arrays
+ *
+ * @param {any[]} a First array to compare
+ * @param {any[]} b Second array to compare
+ * @return {any[]} Unique elements
+ * @deprecated Use ASet to perform Set operations on arrays
+ */
 export function arrayDiff(a: any[], b: any[]): any[] {
 	return makeUnique([
 		...a.filter(v1 => !b.includes((v2: any) => isEqual(v1, v2))),
@@ -33,6 +55,25 @@ export function caseInsensitiveSort(prop: string) {
 	};
 }
 
+/**
+ * Shorthand to find objects with a property value
+ *
+ * @example
+ * ```js
+ * const found = [
+ *   {name: 'Batman'},
+ *   {name: 'Superman'},
+ * ].filter(findByProp('name', 'Batman'));
+ * ```
+ *
+ * @param {string} prop Property to compare (Dot nation supported)
+ * @param value Value property must have
+ * @return {(v: any) => boolean} Function used by `filter` or `find`
+ */
+export function findByProp(prop: string, value: any) {
+	return (v: any) => isEqual(dotNotation(v, prop), value);
+}
+
 /**
  * Recursively flatten nested arrays
  *
@@ -91,10 +132,13 @@ export function sortByProp(prop: string, reverse = false) {
 	};
 }
 
-export function findByProp(prop: string, value: any) {
+/**
-	return (v: any) => isEqual(v[prop], value);
+ * Make sure every element in array is unique
-}
+ *
-
+ * @param {any[]} arr Array that will be filtered in place
+ * @return {any[]} Original array
+ * @deprecated Please use ASet to create a guaranteed unique array
+ */
 export function makeUnique(arr: any[]) {
 	for(let i = arr.length - 1; i >= 0; i--) {
 		if(arr.slice(0, i).find(n => isEqual(n, arr[i]))) arr.splice(i, 1);
@@ -103,7 +147,8 @@ export function makeUnique(arr: any[]) {
 }
 
 /**
- * Make sure value is an array, if it isn't wrap it in one.
+ * Make sure value is an array, if it isn't wrap it in one
+ *
  * @param {T[] | T} value Value that should be an array
  * @returns {T[]} Value in an array
  */

src/cache.ts

@@ -0,0 +1,139 @@
+/**
+ * Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
+ */
+export class Cache<K extends string | number | symbol, T> {
+	private store = <Record<K, T>>{};
+
+	/** Support index lookups */
+	[key: string | number | symbol]: T | any;
+	/** Whether cache is complete */
+	complete = false;
+
+	/**
+	 * Create new cache
+	 *
+	 * @param {keyof T} key Default property to use as primary key
+	 * @param {number} ttl Default expiry in milliseconds
+	 */
+	constructor(public readonly key?: keyof T, public ttl?: number) {
+		return new Proxy(this, {
+			get: (target: this, prop: string | symbol) => {
+				if (prop in target) return (target as any)[prop];
+				return target.store[prop as K];
+			},
+			set: (target: this, prop: string | symbol, value: any) => {
+				if (prop in target) (target as any)[prop] = value;
+				else target.store[prop as K] = value;
+				return true;
+			}
+		});
+	}
+
+	private getKey(value: T): K {
+		if(!this.key) throw new Error('No key defined');
+		return <K>value[this.key];
+	}
+
+	/**
+	 * Get all cached items
+	 *
+	 * @return {T[]} Array of items
+	 */
+	all(): T[] {
+		return Object.values(this.store);
+	}
+
+	/**
+	 * Add a new item to the cache. Like set, but finds key automatically
+	 *
+	 * @param {T} value Item to add to cache
+	 * @param {number | undefined} ttl Override default expiry
+	 * @return {this}
+	 */
+	add(value: T, ttl = this.ttl): this {
+		const key = this.getKey(value);
+		this.set(key, value, ttl);
+		return this;
+	}
+
+	/**
+	 * Add several rows to the cache
+	 *
+	 * @param {T[]} rows Several items that will be cached using the default key
+	 * @param complete Mark cache as complete & reliable, defaults to true
+	 * @return {this}
+	 */
+	addAll(rows: T[], complete = true): this {
+		rows.forEach(r => this.add(r));
+		this.complete = complete;
+		return this;
+	}
+
+	/**
+	 * Delete an item from the cache
+	 *
+	 * @param {K} key Item's primary key
+	 */
+	delete(key: K) {
+		delete this.store[key];
+	}
+
+	/**
+	 * Return cache as an array of key-value pairs
+	 * @return {[K, T][]} Key-value pairs array
+	 */
+	entries(): [K, T][] {
+		return <[K, T][]>Object.entries(this.store);
+	}
+
+	/**
+	 * Get item from the cache
+	 * @param {K} key Key to lookup
+	 * @return {T} Cached item
+	 */
+	get(key: K): T {
+		return this.store[key];
+	}
+
+	/**
+	 * Get a list of cached keys
+	 *
+	 * @return {K[]} Array of keys
+	 */
+	keys(): K[] {
+		return <K[]>Object.keys(this.store);
+	}
+
+	/**
+	 * Get map of cached items
+	 *
+	 * @return {Record<K, T>}
+	 */
+	map(): Record<K, T> {
+		return structuredClone(this.store);
+	}
+
+	/**
+	 * Add an item to the cache manually specifying the key
+	 *
+	 * @param {K} key Key item will be cached under
+	 * @param {T} value Item to cache
+	 * @param {number | undefined} ttl Override default expiry
+	 * @return {this}
+	 */
+	set(key: K, value: T, ttl = this.ttl): this {
+		this.store[key] = value;
+		if(ttl) setTimeout(() => {
+			this.complete = false;
+			this.delete(key);
+		}, ttl);
+		return this;
+	}
+
+	/**
+	 * Get all cached items
+	 *
+	 * @return {T[]} Array of items
+	 */
+	values = this.all();
+}

src/csv.ts

@@ -0,0 +1,26 @@
+import {dotNotation, flattenObj} from './objects.ts';
+
+/**
+ * Convert an object to a CSV string
+ *
+ * @param {any[]} target Array of objects to create CSV from
+ * @param {boolean} flatten Should nested object be flattened or treated as values
+ * @return {string} CSV string
+ */
+export function csv(target: any[], flatten=true) {
+	const headers = target.reduce((acc, row) => {
+		Object.keys(flatten ? flattenObj(row) : row)
+			.forEach(key => { if(!acc.includes(key)) acc.push(key); });
+		return acc;
+	}, []);
+	return [
+		headers.join(','),
+		...target.map(row => headers.map((h: string) => {
+			const value = dotNotation<any>(row, h);
+			const type = typeof value;
+			if(type == 'string' && value.includes(',')) return `"${value}"`;
+			if(type == 'object') return `"${JSON.stringify(value)}"`;
+			return value;
+		}).join(','))
+	].join('\n');
+}

src/emitter.ts

@@ -1,6 +1,10 @@
 export type Listener = (...args: any[]) => any;
 export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...args: any[]) => any};
 
+export type NamespaceEvents<Namespace extends string, Events extends TypedEvents> = {
+	[K in keyof Events as `${Namespace}:${Extract<K, string>}`]: Events[K];
+};
+
 export class TypedEmitter<T extends TypedEvents = TypedEvents> {
 	private static listeners: {[key: string]: Listener[]} = {};
 

src/files.ts

@@ -1,21 +1,41 @@
-import {deepCopy, JSONAttemptParse} from './objects.ts';
+import {makeArray} from './array.ts';
+import {JSONAttemptParse} from './objects.ts';
 import {PromiseProgress} from './promise-progress';
 
-export function download(href: any, name: string) {
+/**
+ * Download blob as a file
+ *
+ * @param {Blob} blob File as a blob
+ * @param {string} name Name blob will be downloaded as
+ */
+export function downloadFile(blob: Blob | string | string[], name: string) {
+	if(!(blob instanceof Blob)) blob = new Blob(makeArray(blob));
+	const url = URL.createObjectURL(blob);
+	downloadUrl(url, name);
+	URL.revokeObjectURL(url);
+}
+
+/**
+ * Download a file from a URL
+ *
+ * @param href URL that will be downloaded
+ * @param {string} name Override download name
+ */
+export function downloadUrl(href: any, name?: string) {
 	const a = document.createElement('a');
 	a.href = href;
-	a.download = name;
+	a.download = name || href.split('/').pop();
 	document.body.appendChild(a);
 	a.click();
 	document.body.removeChild(a);
 }
 
-export function downloadBlob(blob: Blob, name: string) {
+/**
-	const url = URL.createObjectURL(blob);
+ * Open filebrowser & return selected file
-	download(url, name);
+ *
-	URL.revokeObjectURL(url);
+ * @param {{accept?: string, multiple?: boolean}} options accept - selectable mimetypes, multiple - Allow selecting more than 1 file
-}
+ * @return {Promise<File[]>} Array of selected files
-
+ */
 export function fileBrowser(options: {accept?: string, multiple?: boolean} = {}): Promise<File[]> {
 	return new Promise(res => {
 		const input = document.createElement('input');
@@ -32,6 +52,25 @@ export function fileBrowser(options: {accept?: string, multiple?: boolean} = {})
 	});
 }
 
+/**
+ * Create timestamp intended for filenames from a date
+ *
+ * @param {string} name Name of file, `{{TIMESTAMP}}` will be replaced
+ * @param {Date | number | string} date Date to use for timestamp
+ * @return {string} Interpolated filename, or the raw timestamp if name was omitted
+ */
+export function timestampFilename(name?: string, date: Date | number | string = new Date()) {
+	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
+	const timestamp = `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}_${date.getHours().toString().padStart(2, '0')}-${date.getMinutes().toString().padStart(2, '0')}-${date.getSeconds().toString().padStart(2, '0')}`;
+	return name ? name.replace('{{TIMESTAMP}}', timestamp) : timestamp;
+}
+
+/**
+ * Upload file to URL with progress callback using PromiseProgress
+ *
+ * @param {{url: string, files: File[], headers?: {[p: string]: string}, withCredentials?: boolean}} options
+ * @return {PromiseProgress<T>} Promise of request with `onProgress` callback
+ */
 export function uploadWithProgress<T>(options: {
 	url: string;
 	files: File[];

src/index.ts

@@ -1,9 +1,12 @@
 export * from './array';
 export * from './aset';
+export * from './cache';
+export * from './csv';
 export * from './files';
 export * from './emitter';
 export * from './errors';
 export * from './http';
+export * from './jwt';
 export * from './logger';
 export * from './math';
 export * from './misc';
@@ -11,3 +14,5 @@ export * from './objects';
 export * from './promise-progress';
 export * from './string';
 export * from './time';
+export * from './types';
+export * from 'var-persist';

src/jwt.ts

@@ -0,0 +1,15 @@
+import {JSONAttemptParse} from './objects.ts';
+
+/**
+ * Decode a JWT payload, this will not check for tampering so be careful
+ *
+ * @param {string} token JWT to decode
+ * @return {unknown} JWT payload
+ */
+export function jwtDecode<T>(token: string): T {
+	const base64 = token.split('.')[1]
+		.replace(/-/g, '+').replace(/_/g, '/');
+	return <T>JSONAttemptParse(decodeURIComponent(atob(base64).split('').map(function(c) {
+		return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
+	}).join('')));
+}

src/misc.ts

@@ -11,42 +11,3 @@ export function gravatar(email: string, def='mp') {
 	if(!email) return '';
 	return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
 }
-
-/** 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
-}
-
-/**
- *
- * @param {string} url
- * @returns {RegExpExecArray}
- */
-export function urlParser(url: string): ParsedUrl {
-	const processed = new RegExp(
-		'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
-		'gm').exec(url);
-	const groups: ParsedUrl = <any>processed?.groups ?? {};
-	const domains = groups.domain.split('.');
-	if(groups['port'] != null) groups.port = Number(groups.port);
-	if(domains.length > 2) {
-		groups.domain = domains.splice(-2, 2).join('.');
-		groups.subdomain = domains.join('.');
-	}
-	if(groups.query) {
-		const split = (<any>groups.query).split('&'), query: any = {};
-		split.forEach((q: any) => {
-			const [key, val] = q.split('=');
-			query[key] = val;
-		});
-		groups.query = query;
-	}
-	return groups;
-}

src/objects.ts

@@ -27,12 +27,12 @@ export function clean<T>(obj: T, undefinedOnly = false): Partial<T> {
  * Create a deep copy of an object (vs. a shallow copy of references)
  *
  * Should be replaced by `structuredClone` once released.
- *
  * @param {T} value Object to copy
  * @returns {T} Type
+ * @deprecated Please use `structuredClone`
  */
 export function deepCopy<T>(value: T): T {
-	return JSON.parse(JSON.stringify(value));
+	return structuredClone(value);
 }
 
 /**
@@ -91,8 +91,28 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
 	}, obj);
 }
 
+
 /**
- * Recursively flatten a nested object, while maintaining key structure.
+ * Convert object into URL encoded query string
+ *
+ * @example
+ * ```js
+ * const query = encodeQuery({page: 1, size: 20});
+ * console.log(query); // Output: "page=1&size=20"
+ * ```
+ *
+ * @param {any} data - data to convert
+ * @returns {string} - Encoded form data
+ */
+export function encodeQuery(data: any): string {
+	return Object.entries(data).map(([key, value]) =>
+		encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
+	).join('&');
+}
+
+
+/**
+ * Recursively flatten a nested object, while maintaining key structure
  *
  * @example
  * ```ts
@@ -121,6 +141,7 @@ export function flattenObj(obj: any, parent?: any, result: any = {}) {
 
 /**
  * Convert object to FormData
+ *
  * @param target - Object to convert
  * @return {FormData} - Form object
  */
@@ -173,6 +194,12 @@ export function isEqual(a: any, b: any): boolean {
 	return Object.keys(a).every(key => isEqual(a[key], b[key]));
 }
 
+/**
+ * Experimental: Combine multiple object prototypes into one
+ *
+ * @param target Object that will have prototypes added
+ * @param {any[]} constructors Additionally prototypes that should be merged into target
+ */
 export function mixin(target: any, constructors: any[]) {
 	constructors.forEach(c => {
 		Object.getOwnPropertyNames(c.prototype).forEach((name) => {
@@ -186,30 +213,31 @@ export function mixin(target: any, constructors: any[]) {
 	});
 }
 
+/**
+ * Parse JSON but return the original string if it fails
+ *
+ * @param {string} json JSON string to parse
+ * @return {string | T} Object if successful, original string otherwise
+ */
 export function JSONAttemptParse<T>(json: string): T | string {
 	try { return JSON.parse(json); }
 	catch { return json; }
 }
 
-export function JSONSanitized(obj: any, space?: number) {
+/**
+ * Convert an object to a JSON string avoiding any circular references.
+ *
+ * @param obj Object to convert to JSON
+ * @param {number} space Format the JSON with spaces
+ * @return {string} JSON string
+ */
+export function JSONSanitize(obj: any, space?: number): string {
 	let cache: any[] = [];
-	return JSON.parse(JSON.stringify(obj, (key, value) => {
+	return JSON.stringify(obj, (key, value) => {
 		if (typeof value === 'object' && value !== null) {
 			if (cache.includes(value)) return;
 			cache.push(value);
 		}
 		return value;
-	}, space));
+	}, space);
-}
-
-/**
- * Convert object into URL encoded string
- *
- * @param {any} data - data to convert
- * @returns {string} - Encoded form data
- */
-export function urlEncode(data: any): string {
-	return Object.entries(data).map(([key, value]) =>
-		encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
-	).join('&');
 }

src/promise-progress.ts

@@ -1,5 +1,25 @@
 export type ProgressCallback = (progress: number) => any;
 
+/**
+ * A promise that fires the `onProgress` callback on incremental progress
+ *
+ * @example
+ * ```js
+ * const promise = new Promise((resolve, reject, progress) => {
+ *   const max = 10;
+ * 	 for(let i = 0; i < max; i++) progress(i / max);
+ * 	 resolve(1);
+ * });
+ *
+ * console.log(promise.progress);
+ *
+ * promise.onProgress(console.log)
+ *        .then(console.log)
+ *        .catch(console.error)
+ *        .finally(...);
+ *
+ * ```
+ */
 export class PromiseProgress<T> extends Promise<T> {
 	private listeners: ProgressCallback[] = [];
 

src/string.ts

@@ -1,28 +1,12 @@
-export function countChars(text: string, pattern: RegExp) {
+import {dotNotation, flattenObj} from './objects.ts';
-	return text.length - text.replaceAll(pattern, '').length;
-}
-
-export function createHex(length: number) {
-	return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
-}
-
-export function formatBytes(bytes: number, decimals = 2) {
-	if (bytes === 0) return '0 Bytes';
-	const k = 1024;
-	const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
-	const i = Math.floor(Math.log(bytes) / Math.log(k));
-	return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i];
-}
 
 /**
  * String of all letters
- *
  */
 const LETTER_LIST = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
 
 /**
  * String of all numbers
- *
  */
 const NUMBER_LIST = '0123456789';
 
@@ -36,6 +20,27 @@ const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
  */
 const CHAR_LIST = LETTER_LIST + NUMBER_LIST + SYMBOL_LIST;
 
+/**
+ * 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 function formatBytes(bytes: number, decimals = 2) {
+	if (bytes === 0) return '0 Bytes';
+	const k = 1024;
+	const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+	const i = Math.floor(Math.log(bytes) / Math.log(k));
+	return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i];
+}
+
+/**
+ * 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 function formatPhoneNumber(number: string) {
 	const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
 	if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
@@ -46,7 +51,7 @@ export function formatPhoneNumber(number: string) {
  * Insert a string into another string at a given position
  *
  * @example
- * ```
+ * ```js
  * console.log(insertAt('Hello world!', ' glorious', 5);
  * // Output: Hello glorious world!
  * ```
@@ -60,12 +65,36 @@ export function insertAt(target: string, str: string, index: number): String {
 	return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
 }
 
-export function pad(text: any, length: number, char: string, start = true) {
+/**
-	const t = text.toString();
+ * Add padding to string
-	const l = length - t.length;
+ *
-	if(l <= 0) return t;
+ * @example
-	const padding = Array(~~(l / char.length)).fill(char).join('');
+ * ```js
-	return start ? padding + t : t + padding;
+ * 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 function pad(text: any, length: number, char: string = ' ', start = true) {
+	if(start) return text.toString().padStart(length, char);
+	return text.toString().padEnd(length, char);
+}
+
+/**
+ * Generate a random hexadecimal value
+ *
+ * @param {number} length Number of hexadecimal place values
+ * @return {string} Hexadecimal number as a string
+ */
+export function randomHex(length: number) {
+	return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
 }
 
 /**
@@ -149,8 +178,50 @@ export function matchAll(value: string, regex: RegExp | string): RegExpExecArray
 	return ret;
 }
 
+/** 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 function parseUrl(url: string): ParsedUrl {
+	const processed = new RegExp(
+		'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
+		'gm').exec(url);
+	const groups: ParsedUrl = <any>processed?.groups ?? {};
+	const domains = groups.domain.split('.');
+	if(groups['port'] != null) groups.port = Number(groups.port);
+	if(domains.length > 2) {
+		groups.domain = domains.splice(-2, 2).join('.');
+		groups.subdomain = domains.join('.');
+	}
+	if(groups.query) {
+		const split = (<any>groups.query).split('&'), query: any = {};
+		split.forEach((q: any) => {
+			const [key, val] = q.split('=');
+			query[key] = val;
+		});
+		groups.query = query;
+	}
+	return groups;
+}
+
+
 /**
  * Create MD5 hash using native javascript
+ *
  * @param d String to hash
  * @returns {string} Hashed string
  */

src/time.ts

@@ -1,13 +1,17 @@
-export function formatDate(date: Date | number | string) {
+/**
-	const d = date instanceof Date ? date : new Date(date);
+ * Return date formated highest to lowest: YYYY-MM-DD H:mm AM
-	return new Intl.DateTimeFormat("en-us", {
+ *
-		weekday: "long",
+ * @param {Date | number | string} date Date or timestamp to convert to string
-		month: "short",
+ * @return {string} Formated date
-		day: "numeric",
+ */
-		hour: "numeric",
+export function formatDate(date: Date | number | string): string {
-		minute: "numeric",
+	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
-		hour12: true
+	let hours = date.getHours(), postfix = 'AM';
-	}).format(d);
+	if(hours >= 12) {
+		if(hours > 12) hours -= 12;
+		postfix = 'PM';
+	} else if(hours == 0) hours = 12;
+	return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}, ${hours}:${date.getMinutes().toString().padStart(2, '0')} ${postfix}`;
 }
 
 /**
@@ -17,6 +21,7 @@ export function formatDate(date: Date | number | 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
  */
@@ -33,12 +38,13 @@ export 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 {() => boolean | Promise<boolean>} fn Return true to continue
  * @param {number} checkInterval Run function ever x milliseconds
  * @return {Promise<void>} Callback when sleep is over
  */
-export async function sleepUntil(fn : () => boolean, checkInterval=100): Promise<void> {
+export async function sleepUntil(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
-	while(fn()) await sleep(checkInterval);
+	while(await fn()) await sleep(checkInterval);
 }
 
 /**

src/types.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 function tyoeKeys<T extends object>() {
+	return Object.keys(<T>{}) as Array<keyof T>;
+}

tests/misc.spec.ts

@@ -1,4 +1,4 @@
-import {sleep, urlParser} from '../src';
+import {sleep, parseUrl} from '../src';
 
 describe('Miscellanies Utilities', () => {
 	describe('sleep', () => {
@@ -12,7 +12,7 @@ describe('Miscellanies Utilities', () => {
 
 	describe('urlParser', () => {
 		test('localhost w/ port', () => {
-			const parsed = urlParser('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
+			const parsed = parseUrl('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
 			expect(parsed.protocol).toStrictEqual('http');
 			expect(parsed.host).toStrictEqual('localhost:4200');
 			expect(parsed.domain).toStrictEqual('localhost');
@@ -23,7 +23,7 @@ describe('Miscellanies Utilities', () => {
 		});
 
 		test('advanced URL', () => {
-			const parsed = urlParser('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
+			const parsed = parseUrl('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
 			expect(parsed.protocol).toStrictEqual('https');
 			expect(parsed.host).toStrictEqual('sub.domain.example.com');
 			expect(parsed.domain).toStrictEqual('example.com');

tests/object.spec.ts

@@ -29,28 +29,6 @@ describe('Object Utilities', () => {
 		});
 	});
 
-	describe('deepCopy', () => {
-		const copy = deepCopy(TEST_OBJECT);
-		test('Array of arrays', () => {
-			const a = [[1, 2], [3, 4]];
-			const b = deepCopy(a);
-			b[0][1] = 5;
-			expect(a).not.toEqual(b);
-		});
-		test('Change array inside object', () => {
-			copy.b[1] = [1, 1, 1];
-			expect(copy.b[1]).not.toEqual(TEST_OBJECT.b[1]);
-		});
-		test('Change object inside object', () => {
-			copy.g = {h: Math.random()};
-			expect(copy.g).not.toEqual(TEST_OBJECT.g);
-		});
-		test('Change object property inside nested array', () => {
-			copy.c.d[0][0].e = -1;
-			expect(copy.c.d[0][0].e).not.toEqual(TEST_OBJECT.c.d[0][0].e);
-		});
-	});
-
 	describe('dotNotation', () => {
 		test('no object or properties', () => {
 			expect(dotNotation(undefined, 'z')).toStrictEqual(undefined);