mihawk/dist/types/src/tools/data-creator.d.ts

A tiny & simple mock server tool, support json,js,cjs,ts(typescript).

/**
 * 获取一个随机日期
 * @returns {Date}
 */
export declare function createRandDate(): Date;
/**
 * 获取一个随机日期字符串
 * @param {string} fmt = 'yyyy-MM-dd hh:mm:ss'
 * @returns {string}
 */
export declare function createRandDateStr(fmt?: string): string;
/**
 * 获取随机 ID 字符串
 * @param {number} len 字符长度
 * @returns {string} id
 */
export declare function createRandId(len?: number): string;
/**
 * 生成一个 UUID (v4)
 * @returns {string}
 * @description
 * - https://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript#answer-2117523
 */
export declare function createUUID(): string;
/**
 * 生成随机颜色
 * @returns {string} #xxx | #xxxxxx
 * @example
 * const color1 = `#${createRandColor()}`; // #xxxxxx
 * const color2 = `#${createRandColor(true)}`; // #xxx
 */
export declare function createRandColor(short?: boolean): string;
/**
 * 生成随机图地址
 * - base on picsum
 * @param {object} options
 * @returns {string} img src addr
 */
export declare function createRandImage(options?: {
    width?: number;
    height?: number;
    query?: Record<string, any>;
}): string;
/** 默认随机范围字符集(纯字母) */
export declare const RAW_LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz";
/** 默认随机范围字符集(字母+下划线+数字) */
export declare const RAW_CHARS: string;
/**
 * 获取随机内容的字符串，范围限定在 charsLimit 中
 * - 如无定制需求，推荐优先使用 createRandStr 函数
 * @param {number} len 长度
 * @param {string} charsLimit 范围，即由字符组成的字符串，如 'abc'
 * @returns
 */
export declare function createRandStrByLimit(len: number, charsLimit: string): string;
/**
 * 获取随机内容的字符串
 * @overload
 * @param {number} len
 * @returns {string} 指定长度的字符串
 * @example
 * const str = createRandStr(5); // 返回一个长度为 5 的字符串
 */
export declare function createRandStr(len: number): string;
/**
 * 获取随机内容的字符串
 * @overload
 * @param {number} len
 * @param {boolean} onlyLetters 只需要字母
 * @returns {string} 指定长度的字符串
 * @example
 * const str = createRandStr(5, true); // 返回一个长度为 5 的字符串（仅含字母）
 */
export declare function createRandStr(len: number, onlyLetters: boolean): string;
/**
 * 获取随机内容的字符串
 * @overload
 * @param {number} minLen 最小长度
 * @param {number} maxLen 最大长度
 * @returns {string} 符合指定长度范围的字符串
 * @example
 * const str = createRandStr(3, 8); // 返回一个长度在 3-8 之间的字符串，长度随机
 */
export declare function createRandStr(minLen: number, maxLen: number): string;
/**
 * 获取随机内容的字符串
 * @overload
 * @param {number} minLen 最小长度
 * @param {number} maxLen 最大长度
 * @param {boolean} onlyLetters 只需要字母
 * @example
 * const str = createRandStr(3, 8, true); // 返回一个长度在 3-8 之间的字符串（仅含字母），长度随机
 */
export declare function createRandStr(minLen: number, maxLen: number, onlyLetters: boolean): string;
/**
 * 获取一个随机字符
 * @returns {char}
 */
export declare function createRandChar(onlyLetters?: boolean): string;
/**
 * 生成随机 email 地址
 * - 粗略生成，如需更佳效果，请直接使用 mockjs
 * @returns {string}
 */
export declare function createRandEmail(): string;
/**
 * 生成随机手机号
 * - 粗略生成，如需更佳效果，请直接使用 mockjs
 * @returns {string}
 */
export declare function createRandPhone(): string;
/**
 * 生成随机 boolean 值
 * @returns {boolean}
 */
export declare function creataRandBool(): boolean;
/**
 * 创建随机数
 * - 随机数满足范围限定
 * - 随机数是一个整数，而非小数
 * @param {number} min 生成的数限定范围，最小值
 * @param {number} max 生成的数限定范围，最大值
 * @returns {number} 生成的随机数
 */
export declare function createRandNum(min?: number, max?: number): number;
/**
 * 创建随机 IO
 * @param {boolean} isIPV6
 * @returns {string}
 * @example
 * console.log(createRandIp()); // 生成IPv4，例如：192.168.1.1
 * console.log(createRandIp(true)); // 生成IPv6，例如：2001:0db8:85a3:0000:0000:8a2e:0370:7334
 */
export declare function createRandIp(isIPV6?: boolean): string;
/**
 * 生成随机的 URL
 * @returns {string}
 */
export declare function createRandUrl(options?: {
    includeHash?: boolean;
    includeQuery?: boolean;
    specialProtocol?: boolean;
}): string;
/**
 * 生成随机姓名（英文）
 * - 只是简单的 mock 姓和名都不全面
 * @param {string} part
 * @returns {string}
 */
export declare function createRandName(part?: 'full' | 'first' | 'last'): string;
/**
 * 生成随机姓名（中文）
 * - 只是简单的 mock, 姓氏并非完整百家姓
 * @returns {string}
 */
export declare function createRandCname(): string;