@idlebox/common 1.3.6 → 1.3.7

package/docs/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.5"
-    }
-  ]
-}

package/src/array/arrayDiff.ts

@@ -1,31 +0,0 @@
-/**
- * @public
- */
-export interface IArrayUpdate<T> {
-	add: T[];
-	del: T[];
-	same: T[];
-}
-
-/**
- * Compare two array, returns the difference from `before` to `after`
- * @public
- */
-export function arrayDiff<T>(before: T[], after: T[]) {
-	before = before.slice().sort();
-	const add: T[] = after.slice().sort();
-	const del: T[] = [];
-	const same: T[] = [];
-	next: while (before.length) {
-		const item = before.pop()!;
-		for (let j = add.length - 1; j >= 0; j--) {
-			if (item === add[j]) {
-				same.push(item);
-				add.splice(j, 1);
-				continue next;
-			}
-		}
-		del.push(item);
-	}
-	return { add, del, same };
-}

package/src/array/arraySame.ts

@@ -1,15 +0,0 @@
-/**
- * is the two array EXACTLY same
- * @public
- */
-export function isArraySame<T>(a1: T[], a2: T[]): boolean {
-	if (a1.length !== a2.length) {
-		return false;
-	}
-	for (let i = a1.length - 1; i >= 0; i--) {
-		if (a1[i] !== a2[i]) {
-			return false;
-		}
-	}
-	return true;
-}

package/src/array/arrayUnique.ts

@@ -1,50 +0,0 @@
-/**
- * Returns a new array without duplicate values
- * @public
- */
-export function arrayUnique<T>(arr: T[]): T[] {
-	return arr.filter((item, index) => {
-		return arr.lastIndexOf(item) === index;
-	});
-}
-
-/**
- * Removes duplicate values from an array
- * @public
- */
-export function arrayUniqueReference(arr: any[]): void {
-	for (let index = arr.length - 1; index >= 0; index--) {
-		if (arr.lastIndexOf(arr[index]) !== index) {
-			arr.splice(index, 1);
-		}
-	}
-}
-
-export interface IUniqueIdFactory<T> {
-	(item: T): string;
-}
-
-function defaultFactory(t: any) {
-	return t as string;
-}
-
-/**
- * Returns a function to be used in <arr>.filter()
- *
- * the returned function can use multiple times, it will remember all values inter multiple arrays
- *
- * @param {IUniqueIdFactory} idFactory function takes an array element, return it's id to be compare with each other
- * @public
- */
-export function uniqueFilter<T>(idFactory: IUniqueIdFactory<T> = defaultFactory) {
-	const seen: { [id: string]: true } = {};
-	return function uniqueFilterInner(item: T): boolean {
-		const id = idFactory(item);
-		if (seen[id]) {
-			return false;
-		} else {
-			seen[id] = true;
-			return true;
-		}
-	};
-}

package/src/array/normalizeArray.ts

@@ -1,13 +0,0 @@
-/**
- * ensure a value is an array
- * @public
- */
-export function normalizeArray<T>(input: T | T[]): T[] {
-	if (input && Array.isArray(input)) {
-		return input;
-	} else if (typeof input !== undefined) {
-		return [input];
-	} else {
-		return [];
-	}
-}

package/src/array/sortAlpha.ts

@@ -1,15 +0,0 @@
-/**
- * Sort string array alphabet order
- *
- * to be used in <arr>.sort()
- * @public
- */
-export function sortByString(a: string, b: string): number {
-	if (a === b) {
-		return 0;
-	} else if (a > b) {
-		return 1;
-	} else {
-		return -1;
-	}
-}

package/src/date/consts.ts

@@ -1,5 +0,0 @@
-export const oneSecond = 1000;
-export const oneMinute = 60000;
-export const oneHour = 1440000;
-export const oneDay = 86400000;
-export const oneWeek = 604800000;

package/src/date/isInvalid.ts

@@ -1,6 +0,0 @@
-/**
- * Check if a date is NaN
- */
-export function isDateInvalid(date: Date) {
-	return isNaN(date.getTime());
-}

package/src/date/sibling.ts

@@ -1,28 +0,0 @@
-export function nextSecond(d: Date, n = 1) {
-	d.setSeconds(d.getSeconds() + n);
-	return d;
-}
-export function nextMinute(d: Date, n = 1) {
-	d.setMinutes(d.getMinutes() + n);
-	return d;
-}
-export function nextHour(d: Date, n = 1) {
-	d.setHours(d.getHours() + n);
-	return d;
-}
-export function nextDay(d: Date, n = 1) {
-	d.setDate(d.getDate() + n);
-	return d;
-}
-export function nextWeek(d: Date, n = 1) {
-	d.setDate(d.getDate() + n * 7);
-	return d;
-}
-export function nextMonth(d: Date, n = 1) {
-	d.setMonth(d.getMonth() + n);
-	return d;
-}
-export function nextYear(d: Date, n = 1) {
-	d.setFullYear(d.getFullYear() + n);
-	return d;
-}

package/src/date/timeString.ts

@@ -1,150 +0,0 @@
-import { pad2 } from '../string/pad2';
-
-export namespace humanDate {
-	/**
-	 * Format: HH:mm:ss
-	 */
-	export function time(date: Date | string | number) {
-		if (typeof date === 'string') {
-			date = parseInt(date);
-		}
-		date = new Date(date as number);
-		return `${pad2(date.getHours())}:${pad2(date.getMinutes())}:${pad2(date.getSeconds())}`;
-	}
-
-	/**
-	 * Format: YYYY-MM-dd
-	 *
-	 * separator can change
-	 */
-	export function date(date: Date | string | number, sp = '-') {
-		if (typeof date === 'string') {
-			date = parseInt(date);
-		}
-		date = new Date(date as number);
-		return `${date.getFullYear()}${sp}${pad2(date.getMonth() + 1)}${sp}${pad2(date.getDate())}`;
-	}
-
-	/**
-	 * Format: YYYY-MM-dd HH:mm:ss
-	 */
-	export function datetime(date: Date | string | number) {
-		if (typeof date === 'string') {
-			date = parseInt(date);
-		}
-		date = new Date(date as number);
-		return (
-			`${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}` +
-			' ' +
-			`${pad2(date.getHours())}:${pad2(date.getMinutes())}:${pad2(date.getSeconds())}`
-		);
-	}
-
-	export interface ITimeFormatter {
-		(s: number): string;
-	}
-
-	export interface IFormatters {
-		s: ITimeFormatter;
-		m: ITimeFormatter;
-		h: ITimeFormatter;
-		d: ITimeFormatter;
-	}
-
-	const formatters: IFormatters = {
-		s(v: number) {
-			return v + 's';
-		},
-		m(v: number) {
-			return v + 'm';
-		},
-		h(v: number) {
-			return v + 'h';
-		},
-		d(v: number) {
-			return v + 'd';
-		},
-	};
-
-	/**
-	 * set format for time delta
-	 */
-	export function setLocaleFormatter(formatter: Partial<IFormatters>) {
-		Object.assign(formatters, formatter);
-	}
-
-	/**
-	 * format time delta (in ms) to string, like: '1d'
-	 * when ms<=0, returns '0s'
-	 *
-	 * format can set by `setLocaleFormatter`
-	 * day is the largest unit
-	 */
-	export function deltaTiny(ms: number) {
-		if (ms <= 0) {
-			return '0s';
-		}
-		if (ms > 86400000) {
-			return formatters.d(Math.floor(ms / 86400000));
-		}
-		if (ms > 3600000) {
-			return formatters.h(Math.floor(ms / 3600000));
-		}
-		if (ms > 60000) {
-			return formatters.m(Math.floor(ms / 60000));
-		}
-		return formatters.s(Math.floor(ms / 1000));
-	}
-
-	/**
-	 * format time delta (in ms) to string, like: '1d10m42s'
-	 * when ms<=0, returns '0s'
-	 *
-	 * format can set by `setLocaleFormatter`
-	 * day is the largest unit
-	 */
-	export function delta(ms: number) {
-		let ret = '';
-		let val = Math.ceil(ms / 1000);
-
-		if (val <= 0) {
-			return '0s';
-		}
-
-		// sec
-		const s = val % 60;
-		val = Math.floor(val / 60);
-		if (s > 0) {
-			ret = formatters.s(s);
-		}
-		if (val === 0) {
-			return ret;
-		}
-
-		// min
-		const m = val % 60;
-		val = Math.floor(val / 60);
-		if (m > 0) {
-			ret = formatters.m(m) + ret;
-		}
-		if (val === 0) {
-			return ret;
-		}
-
-		// hour
-		const h = val % 24;
-		val = Math.floor(val / 24);
-		if (h > 0) {
-			ret = formatters.h(h) + ret;
-		}
-		if (val === 0) {
-			return ret;
-		}
-
-		// day
-		if (val > 0) {
-			ret = formatters.d(h) + ret;
-		}
-		return ret;
-	}
-}

package/src/date/unix.ts

@@ -1,13 +0,0 @@
-/**
- * Returns ms
- */
-export function getTimeStamp(date: Date) {
-	return Math.floor(date.getTime() / 1000);
-}
-
-/**
- * Takes ms
- */
-export function fromTimeStamp(timestamp: number) {
-	return new Date(1000 * timestamp);
-}

package/src/debugging/tryInspect.ts

@@ -1,37 +0,0 @@
-const inspect = Symbol.for('nodejs.util.inspect.custom'); // high version node
-const inspectOld = tryGetSymbol();
-
-declare const global: any;
-
-function tryGetSymbol() {
-	try {
-		const r = global.require;
-		return r('util').inspect.custom;
-	} catch {
-		return undefined;
-	}
-}
-
-/**
- * try to call `inspect` method of an object, if not exists, call `toString`.
- * @returns {string}
- */
-export function tryInspect(object: any) {
-	if (!object || typeof object !== 'object') {
-		return JSON.stringify(object);
-	}
-
-	if (object[inspect]) {
-		return object[inspect]();
-	} else if (inspectOld && object[inspectOld]) {
-		return object[inspectOld]();
-	} else if (object['inspect']) {
-		return object['inspect']();
-	} else if (object[Symbol.toStringTag]) {
-		return object[Symbol.toStringTag]();
-	} else if (object.toJSON) {
-		return object.toJSON();
-	} else {
-		return '' + object;
-	}
-}

package/src/error/convertUnknown.ts

@@ -1,10 +0,0 @@
-import { getErrorFrame } from './getFrame';
-
-export function convertCatchedError(e: unknown): Error {
-	if (e instanceof Error) {
-		return e;
-	} else {
-		console.error('Catched invalid error at %s, type %s, value %s.', getErrorFrame(new Error(), 1), typeof e, e);
-		return new Error('Invalid: ' + e);
-	}
-}

package/src/error/getFrame.ts

@@ -1,13 +0,0 @@
-/**
- * Get nth line of Error.stack
- * @returns {string} if frame greater than max, return ''
- */
-export function getErrorFrame(e: Error, frame: number): string {
-	if (e && e.stack) {
-		const stackArr = e.stack.split('\n');
-		if (stackArr.length > frame + 1) {
-			return stackArr[frame + 1].trim();
-		}
-	}
-	return '';
-}

package/src/function/asyncCallbackList.ts

@@ -1,75 +0,0 @@
-import { nameFunction } from './functionName';
-
-export interface MyAsyncCallback<Argument extends unknown[]> {
-	displayName?: string;
-
-	(...param: Argument): Promise<void | undefined | boolean> | void | undefined | boolean;
-}
-
-/**
- * like CallbackList, but async
- */
-export class AsyncCallbackList<Argument extends unknown[]> {
-	protected list: MyAsyncCallback<Argument>[] = [];
-	protected running: boolean = false;
-
-	constructor() {
-		this.run = (this.run as any).bind(this);
-	}
-
-	count() {
-		return this.list.length;
-	}
-
-	reset() {
-		if (this.running) {
-			throw new Error("Can not reset when it's running.");
-		}
-		this.list.length = 0;
-	}
-
-	/**
-	 * @param name optional name of `item` (will assign displayName to `item`)
-	 * @returns function list length
-	 */
-	add(item: MyAsyncCallback<Argument>, name?: string): number {
-		if (this.running) {
-			throw new Error("Can not add callback when it's running.");
-		}
-		if (name) {
-			nameFunction(name, item);
-		}
-		return this.list.push(item);
-	}
-
-	/**
-	 * @returns if removed: return `item`; if did not exists: return null
-	 */
-	remove(item: MyAsyncCallback<Argument>): null | MyAsyncCallback<Argument> {
-		if (this.running) {
-			throw new Error("Can not remove callback when it's running.");
-		}
-		const found = this.list.indexOf(item);
-		if (found !== -1) {
-			return this.list.splice(found, 1)[0];
-		}
-		return null;
-	}
-
-	/**
-	 * Stop run if one callback return `true`
-	 * @returns {boolean} true if one callback return true
-	 */
-	async run(...argument: Argument): Promise<boolean> {
-		this.running = true;
-		let ret: boolean | undefined | void;
-		for (const cb of this.list) {
-			ret = await cb(...argument);
-			if (ret === true) {
-				break;
-			}
-		}
-		this.running = false;
-		return ret || false;
-	}
-}

package/src/function/callbackList.ts

@@ -1,84 +0,0 @@
-import { nameFunction } from './functionName';
-
-export interface MyCallback<Argument extends unknown[]> {
-	displayName?: string;
-
-	(...param: Argument): any;
-}
-
-/**
- * Manage a list of callback
- */
-export class CallbackList<Argument extends unknown[]> {
-	protected list: MyCallback<Argument>[] = [];
-	protected running: boolean = false;
-	protected stop: boolean = false;
-
-	constructor() {
-		this.run = (this.run as any).bind(this);
-	}
-
-	count() {
-		return this.list.length;
-	}
-
-	reset() {
-		if (this.running) {
-			throw new Error("Can not reset when it's running.");
-		}
-		this.list.length = 0;
-	}
-
-	/**
-	 * @param name optional name of `item` (will assign displayName to `item`)
-	 * @returns function list length
-	 */
-	add(item: MyCallback<Argument>, name?: string): number {
-		if (this.running) {
-			throw new Error("Can not add callback when it's running.");
-		}
-		if (name) {
-			nameFunction(name, item);
-		}
-		return this.list.push(item);
-	}
-
-	/**
-	 * @returns if removed: return `item`; if did not exists: return null
-	 */
-	remove(item: MyCallback<Argument>): null | MyCallback<Argument> {
-		if (this.running) {
-			throw new Error("Can not remove callback when it's running.");
-		}
-		const found = this.list.indexOf(item);
-		if (found !== -1) {
-			return this.list.splice(found, 1)[0];
-		}
-		return null;
-	}
-
-	/**
-	 * @returns {boolean} true if every callback called, false if stop in middle
-	 */
-	run(...argument: Argument): boolean {
-		if (this.running) {
-			throw new Error("can not run CallbackList in it's callback.");
-		}
-		this.stop = false;
-
-		this.running = true;
-		for (const cb of this.list) {
-			if (this.stop) break;
-			cb(...argument);
-		}
-		this.running = false;
-
-		const ret = !this.stop;
-		this.stop = false;
-		return ret;
-	}
-
-	stopRun() {
-		this.stop = true;
-	}
-}

package/src/function/delayCallbackList.ts

@@ -1,45 +0,0 @@
-import { nameFunction } from './functionName';
-
-export interface MyDelayCallback<Argument extends unknown[]> {
-	displayName?: string;
-
-	(...param: Argument): void;
-}
-
-/**
- * remember arguments after run
- * run all later added function with memorized argument
- */
-export class DelayCallbackList<Argument extends unknown[]> {
-	private delayArgument?: Argument;
-	private delayComplete: boolean = false;
-
-	protected list?: MyDelayCallback<Argument>[] = [];
-
-	count() {
-		return this.list?.length ?? 0;
-	}
-
-	add(item: MyDelayCallback<Argument>, name?: string) {
-		if (name) {
-			nameFunction(name, item);
-		}
-		if (this.delayComplete) {
-			item(...this.delayArgument!);
-		} else {
-			this.list!.push(item);
-		}
-	}
-
-	run(argument: Argument) {
-		if (this.delayComplete) {
-			throw new Error('call to delay callback twice!');
-		}
-		this.delayComplete = true;
-		this.delayArgument = argument;
-		this.list!.forEach((cb) => {
-			cb(...argument);
-		});
-		delete this.list;
-	}
-}

package/src/function/functionName.ts

@@ -1,39 +0,0 @@
-/**
- * Function with displayName
- */
-export interface NamedFunction extends Function {
-	displayName: string;
-}
-
-/**
- * Get displayName/name of a function
- */
-export function functionName(func: Function) {
-	return (func as NamedFunction).displayName || func.name;
-}
-
-/**
- * Set displayName of a function
- */
-export function nameFunction<T extends Function>(name: string, func: T): T & NamedFunction {
-	return Object.assign(func, {
-		displayName: name,
-		inspect() {
-			return `[Function: ${name}]`;
-		},
-	});
-}
-
-export interface MaybeNamedFunction extends Function {
-	displayName?: string;
-}
-
-/**
- * Assert function must have oneof displayName/name property
- */
-export function assertFunctionHasName(func: MaybeNamedFunction) {
-	if (!func.displayName && !func.name) {
-		console.error(func);
-		throw new TypeError('function must have name!');
-	}
-}

package/src/lifecycle/dispose/bridges/rxjs.ts

@@ -1,6 +0,0 @@
-interface Unsubscribable {
-	unsubscribe(): void;
-}
-export function unsubscribableToDisposable(subscription: Unsubscribable) {
-	return { dispose: () => subscription.unsubscribe() };
-}