@ybgnb/utils 0.1.7 → 0.1.9

package/dist/index.d.ts

@@ -1,444 +0,0 @@
-/**
- * 中止异常
- */
-export declare class AbortError extends CommonError {
-    constructor(message?: string);
-}
-
-/**
- * 任意方法
- */
-export declare type AnyFn = (...args: any[]) => any;
-
-/**
- * 业务执行结果
- */
-export declare class BizResult<T> {
-    success: boolean;
-    msg: string;
-    data?: T;
-    constructor(success: boolean, msg: string, data?: T);
-    static createSuccess<T>(data: T): BizResult<T>;
-    static createFail<T>(msg?: string, data?: T): BizResult<T>;
-    static createError<T>(e: unknown): BizResult<T>;
-    /**
-     * 展开成Promise
-     */
-    toPromise(): Promise<void>;
-    toPromise<T>(): Promise<T>;
-}
-
-/**
- * 将数组分块为指定大小的多个子数组
- * @param arr 原数组
- * @param size 每个块的长度
- * @example chunk([1,2,3,4,5], 2) => [[1,2],[3,4],[5]]
- */
-export declare function chunk<T>(arr: T[], size: number): T[][];
-
-/**
- * 通用错误
- */
-export declare class CommonError extends Error {
-    rawError?: Error;
-    constructor(message: string, rawError?: unknown);
-    toString(): string;
-}
-
-/**
- * 转换到通用异常
- */
-export declare function convertToCommonError(error: unknown, prefix?: string): CommonError;
-
-/**
- * 动态调用
- * @param root  对象
- * @param path  调用路径
- * @param args  参数
- */
-export declare function dynamicCall<T = any>(root: any, path: string, ...args: any[]): T;
-
-/**
- * 编码 URL 参数
- * @param params 查询参数
- */
-export declare function encodeURLParams(params: QueryParams): string;
-
-/**
- * 执行业务（自动包裹BuResult）
- * @param run 执行方法
- */
-export declare const execBiz: <T>(run: () => Promise<T>) => Promise<BizResult<T>>;
-
-/**
- * 提取getter属性
- */
-export declare type ExtractGetterProperties<T> = {
-    [K in keyof T as K extends `get${infer Rest}` ? Uncapitalize<Rest> : never]: T[K] extends (...args: any[]) => Promise<infer R> ? R : never;
-};
-
-/**
- * 提取所有函数 key
- */
-export declare type FunctionKeys<T> = {
-    [K in keyof T]: T[K] extends AnyFn ? K : never;
-}[keyof T];
-
-/**
- * 获取异常信息
- */
-export declare function getErrorMessage(error: unknown): string;
-
-/**
- * 格式化时间为 2020-02-02 20:20:20 的字符串
- * @param date 需要格式化的时间，为空则获取当前时间
- */
-export declare function getFormattedDate(date?: Date): string;
-
-/**
- * 格式化时间为 2020-02-02 20:20:20 的字符串
- * @param date 需要格式化的时间，为空则获取当前时间
- */
-export declare function getFormattedDateTime(date?: Date): string;
-
-/**
- * 格式化时间为 20:20:20 的字符串
- * @param date 需要格式化的时间，为空则获取当前时间
- */
-export declare function getFormattedTime(date?: Date): string;
-
-/**
- * 从 <img> 元素获取图片字节数据（ArrayBuffer）
- * @param img 已加载的 <img> 元素
- * @param type 图片类型，可选（默认 png）
- */
-export declare function getImageArrayBuffer(img: HTMLImageElement, type?: string): Promise<ArrayBuffer>;
-
-/**
- * 等待加载完成并获取字节数据
- */
-export declare function getImgArrayBufferAfterLoad(img: HTMLImageElement, type?: string): Promise<ArrayBuffer>;
-
-/**
- * 获取网络信息
- */
-export declare function getNetworkInfo(): NetworkState;
-
-/** github 仓库信息 */
-export declare interface GithubRepository {
-    /** 仓库所有者（用户或组织名） */
-    owner: string;
-    /** 仓库名称 */
-    repo: string;
-    /** 分支名称 */
-    branch: string;
-}
-
-/**
- * 将十六进制颜色转换为 RGB
- */
-export declare const hexToRgb: (hex: string) => {
-    r: number;
-    g: number;
-    b: number;
-};
-
-/**
- * 滚动元素到屏幕中心
- * @param el
- */
-export declare function humanScrollElIntoCenter(el: HTMLElement): Promise<void>;
-
-/**
- * 模拟人类手感滚动到指定位置
- */
-export declare function humanScrollTo(targetX: number, targetY: number): Promise<void>;
-
-/** URL query 中必须编码的保留字符 (RFC 3986) */
-export declare const invalidCharRegex: RegExp;
-
-export declare function isAbortError(error: unknown): error is AbortError;
-
-export declare function isCommonError(error: unknown): error is CommonError;
-
-/**
- * 是否为空数组
- * @param data
- */
-export declare function isEmptyArr(data: unknown): boolean;
-
-/**
- * 判断字符串是否为有效的 HTTP/HTTPS URL
- * @param path - 待检测的字符串
- */
-export declare function isHttpUrl(path: string): boolean;
-
-/**
- * 判断一个值是否为纯对象
- */
-export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
-
-/**
- * 提取 T 中所有值类型为 V 的键
- */
-export declare type KeysMatching<T, V> = {
-    [K in keyof T]: T[K] extends V ? K : never;
-}[keyof T];
-
-/**
- * 用元组限制长度
- */
-export declare type MaxLengthArray<T, N extends number> = T[] & {
-    length: N;
-};
-
-/**
- *
- */
-/**
- * 合并查询参数
- * @param urlSearchParams url解析后查询参数
- * @param params          单独传的查询参数
- */
-export declare function mergeQueryParams(urlSearchParams: URLSearchParams, params?: QueryParams): QueryParams;
-
-/**
- * 提取所有方法
- */
-export declare type MethodKeys<T> = {
-    [K in keyof T]-?: T[K] extends AnyFn ? K : never;
-}[keyof T];
-
-/**
- * 方法参数类型
- */
-export declare type MethodParams<T> = T extends (...args: infer P) => any ? P : never;
-
-/**
- * 方法返回类型
- */
-export declare type MethodReturn<T> = T extends (...args: any[]) => infer R ? R : never;
-
-/**
- * 生成 CSS `color-mix()` 函数的字符串表示，用于动态计算两种颜色的混合结果
- *
- * @param {string} color1 - 参与混合的第一种颜色（支持 CSS 合法颜色值，如 HEX、RGB、HSL 等）
- * @param {string} color2 - 参与混合的第二种颜色
- * @param {number} percentage - 主颜色（color1）在混合中的占比（百分比数值，范围 0-100）
- * @param {'srgb' | 'hsl'} [colorSpace='srgb'] - 色彩空间选项：
- *   - `'srgb'`: 标准 RGB 色彩空间（默认）
- *   - `'hsl'`: 色相-饱和度-明度色彩空间
- * @param {number} [percentage2] - 可选参数：副颜色（color2）的独立占比。
- *   若未提供，则自动计算为 `100 - percentage`
- * @returns {string} 可直接用于 CSS 的 `color-mix()` 函数字符串（如 `color-mix(in srgb, red 30%, blue 70%)`）
- *
- * @example
- * // 基础用法（自动计算互补占比）
- * mixColor('red', 'blue', 30)
- * // 返回: "color-mix(in srgb, red 30%, blue 70%)"
- *
- * @example
- * // 显式指定双占比 + HSL 色彩空间
- * mixColor('#ff0000', '#0000ff', 40, 'hsl', 60)
- * // 返回: "color-mix(in hsl, #ff0000 40%, #0000ff 60%)"
- */
-export declare const mixColor: (color1: string, color2: string, percentage: number, colorSpace?: "srgb" | "hsl", percentage2?: number) => string;
-
-/**
- * 网络信息
- */
-export declare interface NetworkInfo extends EventTarget {
-    downlink: number;
-    rtt: number;
-    effectiveType: 'slow-2g' | '2g' | '3g' | '4g';
-}
-
-/**
- * 网络状态
- * - 'offline': 无网络
- * - 'online': 在线但不支持 NetworkInformation API
- * - NetworkInformation: 含详细网络信息
- */
-export declare type NetworkState = 'offline' | Omit<NetworkInfo, keyof EventTarget> | 'online';
-
-/**
- * 监听网络状态变化
- * @param listener 监听器
- * @returns 成功监听时返回解绑函数
- */
-export declare function onNetworkChange(listener: (info: NetworkState) => void): () => void;
-
-/**
- * 监听页面可见性变化（兼容旧的IE/Chrome）
- * @param listener 监听器
- * @returns 成功监听时返回解绑函数
- */
-export declare function onVisibilityChange(listener: VisibilityChangeListener): (() => void) | null;
-
-/**
- * 已解析的 url
- */
-export declare interface ParsedUrl {
-    baseUrl: string;
-    searchParams: URLSearchParams;
-}
-
-/**
- * 从 url 解析 github 仓库信息
- * @param repositoryUrl 仓库 URL（支持带有git+前缀、具体文件路径）
- */
-export declare function parseGithubRepo(repositoryUrl: string): GithubRepository;
-
-/**
- * 解析 url
- * @param url
- */
-export declare function parseUrl(url: string): ParsedUrl;
-
-/**
- * 物理像素的点位
- */
-export declare interface PhysicalPoint {
-    x: number;
-    y: number;
-}
-
-/**
- * 物理像素的区域数据
- */
-export declare interface PhysicalRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-
-/**
- * 将数字范围按批次处理，每个批次调用一次异步函数
- *
- * @param start - 起始值（包含）
- * @param end   - 结束值（包含）
- * @param batchSize - 每批最大元素个数
- * @param processor - 处理单批数字数组的异步函数
- *
- * @example
- * // 分批处理 1..10，每批最多 3 个数字
- * await processRangeInBatches(1, 10, 3, async (batch) => {
- *   console.log(batch) // 输出: [1,2,3], [4,5,6], [7,8,9], [10]
- * })
- */
-export declare function processRangeInBatches(start: number, end: number, batchSize: number, processor: (batch: number[]) => Promise<void>): Promise<void>;
-
-/** 查询参数 */
-export declare type QueryParams = Record<string, string | number | boolean | null | undefined>;
-
-/**
- * 获取 1~n 的随机数
- */
-export declare function random1ToN(n: number): number;
-
-/**
- * 获取 [min, max) 的随机浮点数
- */
-export declare function randomFloat(min: number, max: number): number;
-
-/**
- * 获取 [min, max] 的随机整数
- */
-export declare function randomInt(min: number, max: number): number;
-
-/**
- * 至少包含一个字段
- */
-export declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];
-
-/**
- * 随机运行参数
- * @param fns
- * @param maxCount 最多执行次数（1 ~ fns.length）
- */
-export declare function runRandomFunctions(fns: Array<() => void>, maxCount?: number): void;
-
-/**
- * 从数组中随机取若干项，不可重复
- */
-export declare function sample<T>(arr: T[], count: number): T[];
-
-/**
- * 从数组中获取随机项
- */
-export declare function sampleOne<T>(arr: T[]): T;
-
-/**
- * 从数组中随机取若干项，可重复
- */
-export declare function sampleWithReplacement<T>(arr: T[], count: number): T[];
-
-/**
- * 将错误转换为可 JSON 序列化的普通对象。
- */
-export declare function serializeError(err: unknown): {
-    name: string;
-    message: string;
-    stack: string | undefined;
-} | {
-    name: string;
-    message: string;
-    stack?: undefined;
-};
-
-/**
- * 设置 html 根元素的 css 变量
- */
-export declare const setCssVar: (k: string, v: string) => void;
-
-/**
- * 数组洗牌
- */
-export declare function shuffle<T>(arr: T[]): T[];
-
-/**
- * 支持取消的 sleep
- * @param ms      延迟毫秒数
- * @param signal  取消信号
- */
-export declare function sleep(ms: number, signal?: AbortSignal): Promise<void>;
-
-/**
- * 支持取消的随机 sleep
- * @param minMS   最小延迟毫秒数
- * @param maxMS   最大延迟毫秒数
- * @param signal  取消信号
- */
-export declare function sleepRandom(minMS: number, maxMS: number, signal?: AbortSignal): Promise<void>;
-
-/**
- * 递归移除对象（或数组）中的所有函数属性，返回一个可安全序列化的副本。
- *
- * @typeParam T - 输入值的类型。
- * @param value - 待处理的值（基本类型、对象、数组等）。
- * @param seen - 内部使用的 WeakMap，用于记录已访问过的对象，防止循环引用。
- *               调用方通常无需传递此参数。
- * @returns 处理后的新副本，其中所有函数属性都被移除。
- *          基本类型（string, number, boolean, null, undefined）将原样返回。
- */
-export declare function stripFunctions<T>(value: T, seen?: WeakMap<object, any>): T;
-
-/** 可见性改变的监听器 */
-export declare interface VisibilityChangeListener {
-    (hidden: boolean): void;
-}
-
-/**
- * 等待滚动
- */
-export declare function waitScrollTo(targetX: number, targetY: number): Promise<void>;
-
-/**
- * 等待 <img> 加载完成
- */
-export declare function whenImageLoaded(img: HTMLImageElement): Promise<HTMLImageElement>;
-
-export { }