mihawk/dist/types/src/composites/rc.d.ts

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

import { Loosify, MihawkRC, MihawkOptions } from '../com-types';
interface InitOptions<T = any> {
    fileType?: 'json' | 'js' | 'ts';
    initConfig?: T;
    tsInfo?: {
        typeName: string;
        typeImportId: string;
    };
    overwrite?: boolean;
}
/**
 * 初始化 .xxxrc.json|js|ts 配置文件
 * @param {string} name 配置文件名（包含 . 前缀，以及 rc 后缀，如 .abcrc；不强制，只是推荐）
 * @param {InitOptions}
 * @param {"json"|"js"|"ts"} options.fileType
 * @param {any} options.initConfig
 * @returns {Promise<void>}
 */
export declare function initRCfile<T = any>(name: string, options?: InitOptions<T>): Promise<void>;
interface GetRcOptions<T = any> {
    initConfig?: T;
}
/**
 * 加载根目录配置文件
 * @param {string} name 配置文件名（包含 . 前缀，以及 rc 后缀，如 .abcrc；不强制，只是推荐）
 * @param {GetRcOptions} options
 * @param {any} options.initConfig 如果不存在时，进行初始化，所需要的初始数据
 * @returns {Promise<FrogaguRcConfig>}
 */
export declare function getRcData<T = any>(name: string, options?: GetRcOptions<Partial<T>>): Promise<Partial<T>>;
/**
 * 格式化 rc 配置
 * @param {any} config
 */
export declare function formatOptionsByConfig(config: Loosify<MihawkRC>): MihawkOptions;
export {};