@allkit/shared 0.0.1

package/README.md

@@ -0,0 +1 @@
+# shared 共享工具库

package/dist/README.md

@@ -0,0 +1 @@
+# shared 共享工具库

package/dist/clipboard/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 复制文本到剪贴板
+ * @param value - 文本内容
+ * @example
+ * ```ts
+ * let isResult= copyTextToClipboard('test')
+ * ```
+ */
+export declare function copyTextToClipboard(value?: string): boolean;

package/dist/cloneDeep/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * A strategy for cloning objects with `cloneDeep`.
+ *
+ * Methods **must** call the `track` function with the new parent
+ * object **before** looping over the input object's
+ * properties/elements for cloning purposes. This protects against
+ * circular references.
+ *
+ * Methods may return the input object to indicate that cloning should
+ * be skipped.
+ *
+ * Methods may return null to indicate that the default cloning logic
+ * should be used.
+ */
+export interface CloningStrategy {
+    cloneMap: <K, V>(parent: Map<K, V>, track: (newParent: Map<K, V>) => Map<K, V>, clone: <T>(value: T) => T) => Map<K, V> | null;
+    cloneSet: <T>(parent: Set<T>, track: (newParent: Set<T>) => Set<T>, clone: <T>(value: T) => T) => Set<T> | null;
+    cloneArray: <T>(parent: readonly T[], track: (newParent: T[]) => T[], clone: <T>(value: T) => T) => T[] | null;
+    cloneObject: <T extends object>(parent: T, track: (newParent: T) => T, clone: <T>(value: T) => T) => T | null;
+    cloneOther: <T>(parent: T, track: (newParent: T) => T, clone: <T>(value: T) => T) => T | null;
+}
+export declare const DefaultCloningStrategy: CloningStrategy;
+/**
+ * 深拷贝
+ *
+ * 默认情况下，唯一被克隆的对象是普通对象、类实例、数组、`Set`实例和`Map`,`Date`
+ * 其他的场景,通过第二个参数自定义Strategy,实现拷贝逻辑(copy Radashi)
+ *
+ * ```ts
+ * const obj = { a: 1, b: { c: 2 } }
+ * const clone = cloneDeep(obj)
+ * ```
+ */
+export declare function cloneDeep<T extends object>(root: T, customStrategy?: Partial<CloningStrategy>): T;
+/**
+ * @deprecated - 请使用cloneDeep
+ *
+ * 深拷贝(与cloneDeep完成相同,历史原因2个名字)
+ * 默认情况下，唯一被克隆的对象是普通对象、类实例、数组、`Set`实例和`Map`,`Date`
+ * 其他的场景,通过第二个参数自定义Strategy,实现拷贝逻辑
+ *
+ * ```ts
+ * const obj = { a: 1, b: { c: 2 } }
+ * const clone = deepClone(obj)
+ * ```
+ */
+export declare const deepClone: typeof cloneDeep;

package/dist/constants.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 普通是与否枚举
+ */
+export declare enum EnumYesNo {
+    /**
+     * 是('1')
+     */
+    YES = 1,
+    /**
+     * 否('0')
+     */
+    NO = 0
+}
+/**
+ * 普通是与否枚举(10,20)
+ */
+export declare enum EnumYesNoPlus {
+    /**
+     * 是('10')
+     */
+    YES = "10",
+    /**
+     * 否('20')
+     */
+    NO = "20"
+}

package/dist/cookie/index.d.ts

@@ -0,0 +1,31 @@
+import { default as Cookies } from 'js-cookie';
+/**
+ * 设置cookie
+ * @param name - cookie的key
+ * @param value - cookie的内容
+ * @param options - cookie的配置
+ * @example
+ * ```ts
+ *  setCookie('name', 'value')
+ *  setCookie('name', 'value', { expires: 30 })
+ * ```
+ */
+export declare function setCookie(name: string, value: string, options?: Parameters<typeof Cookies.set>[2]): void;
+/**
+ * 获取指定name的cookie值
+ * @param name - cookie的key
+ * @example
+ * ```ts
+ *  getCookie('name')
+ * ```
+ */
+export declare function getCookie(name: string): string | undefined;
+/**
+ * 删除指定name的cookie
+ * @param name - cookie的key
+ * @example
+ * ```ts
+ *  removeCookie('name')
+ * ```
+ */
+export declare function removeCookie(name: string): void;

package/dist/date/index.d.ts

@@ -0,0 +1,133 @@
+import { default as dayjs, OpUnitType, QUnitType } from 'dayjs';
+import { DurationUnitType } from 'dayjs/plugin/duration';
+/**
+ * 使用dayjs的实例
+ * @param  date - 日期
+ * @param  fmt -格式 YYYY-MM-DD HH:mm:ss
+ * @example
+ * ```ts
+ *  //默认当前时间,返回dayjs()实例,可以format,diff,subtract等方法
+ *  useDate().format('YYYY-MM-DD HH:mm:ss')
+ *  //指定时间戳
+ *  useDate(1709286300000).format('YYYY-MM-DD HH:mm:ss')
+ *  useDate(2024-03-02 00:00)
+ *  useDate(new Date(2024, 2, 1))
+ * ```
+ */
+export declare const useDate: (date?: dayjs.ConfigType, format?: dayjs.OptionType, strict?: boolean) => dayjs.Dayjs;
+/**
+ * 给定日期转成特点格式字符串
+ * @param  date - 日期
+ * @param  fmt -格式 YYYY-MM-DD HH:mm:ss
+ * @example
+ * ```ts
+ *  dateFormat(1709286300000,'YYYY-MM-DD')
+ *  dateFormat(2024-03-02 00:00,'YYYY-MM-DD')
+ *  dateFormat(new Date(2024, 2, 1),'YYYY-MM-DD HH:mm')
+ * ```
+ */
+export declare const dateFormat: (date: dayjs.ConfigType, fmt?: string) => string;
+/**
+ * 返回当前时间,默认到分钟的格式
+ * @param date - 日期
+ * @param fmt - 格式
+ * @returns date-日期 YYYY-MM-DD HH:mm
+ * @example
+ * ```ts
+ *  minute(1709286300000)
+ *  minute(2024-03-02 00:00)
+ *  minute(new Date(2024, 2, 1))
+ * ```
+ */
+export declare const minute: (date: dayjs.ConfigType, fmt?: string) => string;
+/**
+ * 返回月份天数
+ * @param date -  日期
+ * @returns 天数
+ */
+export declare const dateMonthDays: (date?: dayjs.ConfigType) => number;
+/**
+ * 返回前后i天的日期字符串
+ * @param  i - 0返回今天的日期、1返回明天的日期，2返回后天得日期，依次类推
+ * @param format- 格式 YYYY-MM-DD
+ * @returns  format 格式的起始日期字符串
+ * ```ts
+ *  getCurrDate()
+ *  getCurrDate(1)
+ * ```
+ */
+export declare function getCurrDate(i?: number, format?: string): string;
+/**
+ * 返回指定单位下两个日期时间之间的差异。
+ * @param  date1 -第一个时间
+ * @param  date2 -第二个时间,默认是今天
+ * @returns  两个日期时间之间的差异时间戳
+ * @example
+ * ```ts
+ *  dateDiff(1709286300000)
+ *  dateDiff(1709286300000,1709286400000)
+ * ```
+ */
+export declare function dateDiff(date1: dayjs.ConfigType, date2?: dayjs.ConfigType, unit?: QUnitType | OpUnitType): number;
+type Format = {
+    minuteAgo?: string;
+    today?: string;
+    yesterday?: string;
+    future?: string;
+    other?: string;
+};
+/**
+ * 根据指定日期距今天日期的时间差,展示不同格式。
+ * - 时间差小于1小时，展示为 X分钟前
+ * - 时间差-今天内，展示为 今天 HH:MM
+ * - 时间差-昨天的时间，展示为 昨天 HH:MM
+ * - 其他，展示为 YYYY/MM/DD
+ * @param  date - 指定日期
+ * @example
+ * ```ts
+ *  dateFromNow('2024-03-02 00:00')
+ *  dateFromNow('2024-03-02 00:00',{ minuteAgo: '${m} 分钟前'})
+ *  dateFromNow('2024-03-02 00:00', { other: `${YYYY-MM-DD}`})
+ * ```
+ */
+export declare function dateFromNow(date: dayjs.ConfigType, _format?: Format): string;
+/**
+ * 计算两个日期之间的差值(自然年月日)
+ * @param  startDate - 起始日期，格式为 'YYYY-MM-DD HH:mm:ss'
+ * @param  endDate - 结束日期，格式为 'YYYY-MM-DD HH:mm:ss'
+ * @param format - 输出格式，如 'YY年MM月DD日', 'HH小时mm分钟ss秒' 等 (默认YY年MM个月DD天)
+ * @returns  根据格式包含差值的字符串
+ */
+export declare function dateDiffFormat(startDate: string | number | Date, endDate?: string | number | Date, format?: string): string;
+export declare function durationFormat(duration: string | number, config?: {
+    unit?: DurationUnitType;
+    format?: string;
+}): string;
+export declare function durationFormat(duration: string | number, config?: {
+    unit?: DurationUnitType;
+    format: Array<string>;
+}): Array<string>;
+/**
+ * 根据传入的数值，返回格式化后的时间(会自动去掉为0的格式)
+ * @param  duration -传入的数值
+ * @param  config - 可选的配置项(默认 unit='ms',format=''HH小时mm分钟')
+ *
+ * - unit 代表duration的值是什么单位, ('d' | 'D' | 'M' | 'y' |'H' | 'h' | 'm' | 's' | 'ms')
+   - format 返回的数据格式 (比如:'HH小时mm分钟',  ['D','H','m']等)
+ * @returns  格式化后的时间
+ * @example
+ * ```ts
+    const m = durationFormatNoZero(61, {
+      unit: 'm',
+    })
+    const _date = durationFormatNoZero(61, {
+      unit: 'm',
+      format: 'HH:mm',
+    })
+ * ```
+ */
+export declare function durationFormatNoZero(duration: string | number, config?: {
+    unit?: DurationUnitType;
+    format?: string;
+}): Array<string> | string;
+export {};

package/dist/device/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 是否是Android客户端
+ * @example
+ * ```ts
+ * let result= isAndroid()
+ * ```
+ */
+export declare function isAndroid(): boolean;
+/**
+ * 是否是ios客户端
+ * @example
+ * ```ts
+ * let result= isIos()
+ * ```
+ */
+export declare function isIos(): boolean;
+/**
+ * 是否是鸿蒙系统
+ * @example
+ * ```ts
+ * let result= isHarmony()
+ * ```
+ */
+export declare function isHarmony(): boolean;
+/**
+ * 是否是微信客户端
+ * @example
+ * ```ts
+ * let result= isWeChat()
+ * ```
+ */
+export declare function isWeChat(): boolean;
+/**
+ * 是否是微信小程序
+ * @example
+ * ```ts
+ * let result= isWxMiniProgram()
+ * ```
+ */
+export declare function isWxMiniProgram(): boolean;
+export declare enum EnumDeviceBrand {
+    /** 小米 */
+    XIAOMI = "xiaomi",
+    /** OPPO */
+    OPPO = "oppo",
+    /** Vivo */
+    VIVO = "vivo",
+    /** 华为 */
+    HUAWEI = "huawei",
+    /** 荣耀 */
+    HONOR = "honor",
+    /** 一加 */
+    ONE_PLUS = "oneplus",
+    /** 三星 */
+    SAMSUNG = "samsung",
+    /** 苹果 */
+    IPHONE = "iphone",
+    /** 魅族 */
+    MEIZU = "meizu",
+    /** 联想 */
+    LENOVO = "lenovo"
+}
+/**
+ * 获取设备厂商
+ * @example
+ * ```ts
+ * let brand = getDeviceBrand()
+ * ```
+ */
+export declare function getDeviceBrand(): EnumDeviceBrand | undefined;

package/dist/element/index.d.ts

@@ -0,0 +1,12 @@
+export declare const getGlobalThis: () => any;
+export declare const requestAnimationFrame: (fn: FrameRequestCallback) => number;
+export declare const cancelAnimationFrame: (handle: number) => void;
+export declare const raf: () => Promise<unknown>;
+export declare const doubleRaf: () => Promise<unknown>;
+export declare const getStyle: (element: Element) => CSSStyleDeclaration;
+/** 获取dom的rect */
+export declare const getRect: (element: Element | Window) => DOMRect;
+export declare const inViewport: (element: HTMLElement) => boolean;
+export declare const preventDefault: (event: Event) => void;
+export declare const getScrollTop: (element: Element | Window) => number;
+export declare const getScrollLeft: (element: Element | Window) => number;

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export * from './clipboard';
+export * from './cloneDeep';
+export * from './cookie';
+export * from './date';
+export * from './device';
+export * from './element';
+export * from './is';
+export * from './lodash';
+export * from './number';
+export * from './storage';
+export * from './string';
+export * from './timer';
+export * from './constants';

package/dist/is/index.d.ts

@@ -0,0 +1,181 @@
+export declare function is(val: unknown, type: string): boolean;
+/**
+ * 判断不是undefined
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isDef('test')
+ * ```
+ */
+export declare function isDef<T = unknown>(val?: T): val is T;
+/**
+ * 判断是undefined
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isUnDef('test')
+ * ```
+ */
+export declare function isUnDef<T = unknown>(val?: T): val is T;
+/**
+ * 判断是Object,包含数组
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isObject({name:1})
+ * ```
+ */
+export declare function isObject(val: any): val is Record<any, any>;
+/**
+ * 判断是原始Object,不包含数组
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isPlainObject({name:1})
+ * ```
+ */
+export declare function isPlainObject(val: unknown): val is Record<string, unknown>;
+/**
+ * 检测当前类型是否是空对象
+ * @param obj - 检测当前类型
+ * @returns 如果为空的对象则返回true、否则返回false
+ */
+export declare const isEmptyObject: (obj: any) => boolean;
+/**
+ * 检测当前类型是否空(空string|undefined|null)
+ * @param val - 检测当前类型
+ * @returns 如果为空的对象则返回true、否则返回false
+ */
+export declare const isEmptyValue: (val: string | number | null | undefined) => boolean;
+/**
+ * 判断是空,包括空数组,空对象,空Map
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isEmpty({name:1})
+ * ```
+ */
+export declare function isEmpty<T = unknown>(val: T): val is T;
+/**
+ * 判断是日期对象
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isDate(new Date())
+ * ```
+ */
+export declare function isDate(val: unknown): val is Date;
+/**
+ * 判断是否为null
+ * @param val - 任意值
+ * @returns  boolean
+ */
+export declare function isNull(val: unknown): val is null;
+/**
+ * 判断是null和undefined
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isNullAndUnDef('')
+ * ```
+ */
+export declare function isNullAndUnDef(val: unknown): val is null | undefined;
+/**
+ * 判断是null或undefined
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isNullOrUnDef('')
+ * ```
+ */
+export declare function isNullOrUnDef(val: unknown): val is null | undefined;
+/**
+ * 是否是number
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isNumber('test')
+ * ```
+ */
+export declare function isNumber(val: unknown): val is number;
+/**
+ * 是否是Promise
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isPromise('test')
+ * ```
+ */
+export declare function isPromise<T = any>(val: any): val is Promise<T>;
+export declare function isString(val: unknown): val is string;
+/**
+ * 是否是函数
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isFunction('test')
+ * ```
+ */
+export declare function isFunction(val: unknown): val is Function;
+export declare function isBoolean(val: unknown): val is boolean;
+/**
+ * 是否是正则
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isRegExp(window)
+ * ```
+ */
+export declare function isRegExp(val: unknown): val is RegExp;
+/**
+ * 是否是数组
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isArray(window)
+ * ```
+ */
+export declare function isArray(val: any): val is Array<any>;
+/**
+ * 是否是Window
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isWindow(window)
+ * ```
+ */
+export declare function isWindow(val: any): val is Window;
+export declare function isElement(val: unknown): val is Element;
+/**
+ * 是否是Map
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isMap(window)
+ * ```
+ */
+export declare function isMap(val: unknown): val is Map<any, any>;
+export declare function isSet(val: unknown): val is Set<any>;
+export declare const isServer: boolean;
+export declare const isClient: boolean;
+/**
+ * 是否是isUrl
+ * @param val  -内容
+ * @example
+ * ```ts
+ * let result= isUrl('http://www.baidu.com')
+ * ```
+ */
+export declare function isUrl(path: string): boolean;
+/**
+ * 判断是否为整数
+ * @param val - 任意值
+ * @returns 如果是整数则返回true，否则返回false
+ */
+export declare function isInteger(val: unknown): boolean;
+/**
+ * 判断是否为数字（整数或浮点数）
+ * @param val - 任意值
+ * @returns 如果是数字则返回true，否则返回false
+ */
+export declare function isNumeric(val: unknown): boolean;