@hairy/utils 0.6.9 → 0.6.11

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export { default as pPipe } from 'p-pipe';
-export { default as delay } from 'delay';
+import _pPipe from 'p-pipe';
+import Bignumber from 'bignumber.js';
+export { default as Bignumber } from 'bignumber.js';
 
 declare const isBrowser: () => boolean;
 declare const isWeex: () => boolean;
@@ -14,7 +15,15 @@ declare const isIOS: () => boolean;
 declare const isChrome: () => boolean | "";
 declare const isPhantomJS: () => boolean | "";
 declare const isFF: () => false | RegExpMatchArray | null;
-declare const isMobile: () => boolean;
+declare const isMobile: () => boolean;
+declare const isObject: (value: any) => value is object;
+declare const isNumber: (value: any) => boolean;
+declare const isString: (value: any) => boolean;
+declare const isArray: (value: any) => value is any[];
+declare const isNull: (value: any) => value is null;
+declare const isPlainObject: (value: any) => boolean;
+declare const isFormData: (value: any) => value is FormData;
+declare const isWindow: (value: any) => value is Window;
 
 /**
  * 将 formData 转换为 object
@@ -25,10 +34,7 @@ declare function formDataToObject(formData: FormData): Record<string, string>;
  * 将 object 转换为 formData
  * @param object
  */
-declare function objectToFormData(object: Record<string, string | File>): FormData;
-declare function isFormData(value: any): value is FormData;
-declare function isWindow(value: any): value is Window;
-declare function isObject(value: any): value is object;
+declare function objectToFormData(object: Record<string, string | File>): FormData;
 
 type Numeric = string | number | bigint;
 type DynamicObject = {
@@ -98,19 +104,116 @@ declare function getTypeof(target: any): TypeofType;
  */
 declare function isTypeof(target: any, type: TypeofType): boolean;
 
-type Deferred<T = void> = Promise<T> & {
-    resolve: (value: T) => void;
-    reject: (value?: any) => void;
+declare class Deferred<T> extends Promise<T> {
+    resolve: (value: T) => Deferred<T>;
+    reject: (reason?: any) => Deferred<T>;
+    constructor();
+}
+
+declare const pPipe: typeof _pPipe;
+declare const pipe: (...fns: any[]) => any;
+declare const compose: (...fns: any[]) => any;
+
+declare function noop(): any;
+declare function delay(ms: number): Promise<unknown>;
+declare function arange(x1: number, x2?: number, stp?: number, z?: number[], z0?: number): number[];
+declare function whenever<T, C extends (value: Exclude<T, null | undefined>) => any>(value: T, callback: C): ReturnType<C> | undefined;
+declare function loop<T = void>(fn: (next: (ms: number) => Promise<T>) => Promise<T>): Promise<T>;
+declare function riposte<T>(...args: [cond: boolean, value: T][]): T;
+
+declare const BIG_INTS: {
+    t: {
+        v: number;
+        d: number;
+        n: string;
+    };
+    b: {
+        v: number;
+        d: number;
+        n: string;
+    };
+    m: {
+        v: number;
+        d: number;
+        n: string;
+    };
+    k: {
+        v: number;
+        d: number;
+        n: string;
+    };
 };
-declare function createDeferred<T = void>(): Deferred<T>;
+/**
+ *  Any type that can be used where a big number is needed.
+ */
+type Numberish = Numeric | {
+    toString: (...args: any[]) => string;
+};
+type Delimiter = 'k' | 'm' | 'b' | 't';
+interface DecimalOptions {
+    d?: number;
+    r?: Bignumber.RoundingMode;
+}
+interface FormatGroupOptions {
+    size?: number;
+    symbol?: string;
+}
+interface FormatNumericOptions {
+    delimiters?: Delimiter[] | false;
+    rounding?: Bignumber.RoundingMode;
+    decimals?: number;
+    format?: Bignumber.Format;
+}
+declare function unum(num?: Numeric): Bignumber;
+declare function gte(num: Numeric, n: Numeric): boolean;
+declare function gt(num: Numeric, n: Numeric): boolean;
+declare function lte(num: Numeric, n: Numeric): boolean;
+declare function lt(num: Numeric, n: Numeric): boolean;
+declare function plus(array: Numeric[], options?: DecimalOptions): string;
+declare function average(array: Numeric[], options?: DecimalOptions): string;
+/**
+ * calculate percentage
+ * @param total
+ * @param count
+ */
+declare function percentage(total: Numeric, count: Numeric, options?: DecimalOptions): string;
+/**
+ * leading zeros
+ * @param number_
+ * @param lh
+ */
+declare function zerofill(value: Numberish, n?: number, type?: 'positive' | 'reverse'): Numberish;
+declare function numerfix(value: any): string;
+/**
+ * format as a positive integer
+ * @param value
+ */
+declare function integer(value: Numberish): string;
+/**
+ * retain n decimal places
+ * @param value
+ * @param n
+ */
+declare function decimal(value: Numberish, n?: number): string;
+declare function parseNumeric(num: Numeric, delimiters?: Delimiter[]): {
+    v: number;
+    d: number;
+    n: string;
+};
+/**
+ * format number thousand separator and unit
+ * @param value
+ * @param options
+ * @returns
+ */
+declare function formatNumeric(value?: Numeric, options?: FormatNumericOptions): string;
 
 /**
- * 生成区间数组
- * arange(<start>, <stop>, [step=1], [target=[]], [at])
+ * Intercept front and back characters, hide middle characters
+ * @param value
+ * @param mode
+ * @param symbol
  */
-declare function arange(x1: number, x2?: number, stp?: number, z?: number[], z0?: number): number[];
-declare const pipe: (...fns: any[]) => any;
-declare const compose: (...fns: any[]) => any;
-declare function whenever<T, C extends (value: Exclude<T, null | undefined>) => any>(value: T, callback: C): ReturnType<C> | undefined;
+declare function cover(value: string, mode: [number, number, number], symbol?: string): string;
 
-export { Arrayable, Awaitable, BooleanLike, DeepKeyof, DeepPartial, DeepReadonly, DeepReplace, DeepRequired, Deferred, Dimension, DynamicObject, Key, NumberObject, Numeric, NumericObject, Option, StringObject, SymbolObject, TypeofType, UA, arange, compose, createDeferred, formDataToObject, formatSize, formatUnit, getTypeof, isAndroid, isBrowser, isChrome, isEdge, isFF, isFormData, isIE, isIE11, isIE9, isIOS, isMobile, isObject, isPhantomJS, isTypeof, isWeex, isWindow, objectToFormData, pipe, weexPlatform, whenever };
+export { Arrayable, Awaitable, BIG_INTS, BooleanLike, DecimalOptions, DeepKeyof, DeepPartial, DeepReadonly, DeepReplace, DeepRequired, Deferred, Delimiter, Dimension, DynamicObject, FormatGroupOptions, FormatNumericOptions, Key, NumberObject, Numberish, Numeric, NumericObject, Option, StringObject, SymbolObject, TypeofType, UA, arange, average, compose, cover, decimal, delay, formDataToObject, formatNumeric, formatSize, formatUnit, getTypeof, gt, gte, integer, isAndroid, isArray, isBrowser, isChrome, isEdge, isFF, isFormData, isIE, isIE11, isIE9, isIOS, isMobile, isNull, isNumber, isObject, isPhantomJS, isPlainObject, isString, isTypeof, isWeex, isWindow, loop, lt, lte, noop, numerfix, objectToFormData, pPipe, parseNumeric, percentage, pipe, plus, riposte, unum, weexPlatform, whenever, zerofill };