1.0.0 • Published 2 years ago

node-jarvis v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

some useful functions for nodejs development and some database connect functions

/**
 * asynchronous function returns in designative time
 * @param ms millsecond
 */
export function sleep(ms?: number): Promise<void>;
/**
 * use JSON module to simply clone an object, low performance
 * @param obj source object to clone
 */
export function jsonClone<T>(obj: T): T;
/**
 * clone an object by recursion, to avoid same reference for same memory address
 * @param obj
 */
export function deepClone<T>(obj: T): T;
/**
 * generate a random number from min to max
 * @param min minimum bundary
 * @param max maximum bundary
 */
export function random(min: number, max: number): number;
/**
 * unique an array data by using Set
 * @param arr origin data
 */
export function unique(arr: Array<any>): Array<any>;
/**
 * parse millsecond number to time span string
 * @param mills
 * @returns time span
 */
export function parseTimespan(mills: number): string;
/**
 * print a process in a loop, with time options
 * @param current current number for loop
 * @param total total number for loop
 * @param options options for function
 */
export function printPercent(current: number, total: number, options?: PercentBar): void;
/**
 * if call this function, Date prototype will load a format function, eg: new Date().format("YYYY-MM-DD")
 */
export function enableOriginFormat(): void;
/**
 * * data form:
 * [
 *  ['head0', 'head1', 'head2', 'head3'],
 *  ['row00', 'row01', 'row02', 'row03'],
 *  ['row10', 'row11', 'row12', 'row13'],
 *  ['row20', 'row21', 'row22', 'row23']
 * ]
 * @param path output filepath, include file name
 * @param data sheet data
 */
export function outputExcel(path: string, data: Array<Array<string>>): void;
/**
 * read one xlsx file, returns Array
 * @param path input filepath, include file name
 */
export function readExcel(path: string): Array<any>;