mihawk
Version:
A tiny & simple mock server tool, support json,js,cjs,ts(typescript).
43 lines (42 loc) • 1.47 kB
TypeScript
/// <reference types="node" />
/// <reference types="node" />
import { type WriteFileOptions, type JsonWriteOptions } from 'fs-extra';
/**
* 安全写文件，如果其目录不存在，会自动创建
* @param {string} filePath
* @param {string} data
* @param {WriteFileOptions} options
* @returns {void}
*/
export declare function writeFileSafeSync(filePath: string, data: string, options?: WriteFileOptions): void;
/**
* 安全写 JSON 文件，如果其目录不存在，会自动创建
* @param {string} jsonFilePath 绝对路径
* @param {any} obj
* @param {JsonWriteOptions} options
* @returns {void}
*/
export declare function writeJSONSafeSync(jsonFilePath: string, obj: any, options?: JsonWriteOptions): void;
interface ReadFileOptionsObj {
encoding: BufferEncoding;
flag?: string | undefined;
}
/**
* 读文件常规 options
*/
export type ReadFileOptions = ReadFileOptionsObj | BufferEncoding;
/**
* 安全读取文件的文本内容
* @param {string} filePath
* @param {ReadFileOptionsObj} options
* @returns {string}
*/
export declare function readFileSafeSync(filePath: string, options?: ReadFileOptionsObj): string;
/**
* 安全解析 json 文件，并返回 json 对象
* @param {string} jsonFilePath
* @param {ReadFileOptions} options
* @returns {object} json 对象
*/
export declare function readJsonSafeSync<T = Record<any, any>>(jsonFilePath: string, options?: ReadFileOptions): Record<string, any>;
export {};