esuse/index.d.ts

Wei Design, a es toolkit, esuse

/**
 * useDelay
 * @returns
 */
export declare const useDelay: (delay: number) => Promise<unknown>;

/**
 * useFileBase64
 * @returns
 */
export declare function useFileBase64(): Promise<void>;

/**
 * 下载图片到本地
 * @param {string} url - 图片的 URL 地址，可以是同源或跨域资源。
 * @param {string} [fileName="image.png"] - 下载保存的文件名（可选），默认为 "image.png"。
 * @returns {Promise<string>} 一个 Promise，在下载成功后 resolve，失败时 reject。
 * @throws {Error} 如果跨域请求图片失败，会抛出错误。
 * @example
 * // 下载同源图片
 * downloadImage('/assets/example.png', 'example.png');
 *
 * // 下载跨域图片
 * downloadImage('https://example.com/image.jpg', 'downloaded-image.jpg');
 */
export declare function useFileDownload(url: string, fileName?: string): Promise<string>;

/**
 * useFileInfo
 * @returns
 */
export declare function useFileInfo(): Promise<void>;

/**
 * Returns various filename components.
 * Example:
 * - fullFilename: 'file.txt'
 * - filename: 'file'
 * - suffix: 'txt'
 */
export declare function useFilenameDetails(fullFilename: string): {
    filename: string;
    suffix: string | null;
};

/**
 * Returns various path components.
 * Example:
 * - path: 'dir/file.txt'
 * - directory: 'dir'
 * - fullFilename: 'file.txt'
 * - filename: 'file'
 * - suffix: 'txt'
 */
export declare function usePathDetails(path: string): {
    filename: string;
    suffix: string | null;
    directory: string;
    fullFilename: string;
};

/**
 * useUrlBase64
 * @returns
 */
export declare function useUrlBase64(): Promise<void>;

/**
 * useUuid
 * @returns
 */
export declare const useUuid: (length?: number) => string;

export declare const version: string;

export { }