hys-fs-util
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

hys-fs-util

安装依赖

npm install --save hys-fs-util

接口

/**
 * 文件写入内容
 * @param filename 文件名称
 * @param data 数据
 * @param subDirname 子目录名称
 * @param fileExtname 文件扩展名称
 * @param bAppendTime 是否追加时间
 */
writeFile(filename: string, data: any, subDirname ? : string, fileExtname ? : string, bAppendTime ? : boolean): void;

/**
 * 文件追加内容
 * @param filename 文件名称
 * @param data 数据
 * @param subDirname 子目录名称
 * @param fileExtname 文件扩展名称
 * @param bAppendTime 是否追加时间
 */
appendFile(filename: string, data: any, subDirname ? : string, fileExtname ? : string, bAppendTime ? : boolean): void;

/**
 * 文件读取内容
 * @param filename 文件名称
 * @param subDirname 子目录名称
 * @param fileExtname 文件扩展名称
 */
readFile(filename: string, subDirname ? : string, fileExtname ? : string): string;

/**
 * 获取文件路径
 * @param filename 文件名称
 * @param subDirname 子目录名称
 * @param fileExtname 文件扩展名称
 * @return {Object} fileBasename 基础名称, fileDirname 文件目录, filePath 文件路径
 */
filePathObj(filename: string, subDirname ? : string, fileExtname ? : string): { fileBasename: string, fileDirname: string, filePath: string };

/**
 * 文件删除
 * @param filename 文件名称
 * @param subDirname 子目录名称
 * @param fileExtname 文件扩展名称
 */
unlink(filename: string, subDirname ? : string, fileExtname ? : string): void;

/**
 * 获取文件路径组
 * @param fileDirname 文件目录路径
 */
getFilePathArr(fileDirname: string): Array < string > ;

/**
 * 获取指定路径下的文件名称组
 * @param fileDirname 文件目录路径
 */
getFilenameArr(fileDirname: string): Array < string > ;

测试代码

import { FsUtil } from "hys-fs-util";

let fsUtil = new FsUtil();
// 文件目录
let fileDir = "tempDir";
// 文件名称
let filename = "msg";
// 创建一条对象消息
let createObjMsg = {"msg": "创建一条对象消息"};
// 追加一条字符串消息
let appendStrMsg = "追加一条字符串消息"
fsUtil.writeFile(filename, createObjMsg, fileDir);
fsUtil.appendFile(filename, appendStrMsg, fileDir);

let readFile = fsUtil.readFile(filename, fileDir);
console.log("读取文件:", readFile);

let filePathObj = fsUtil.filePathObj(filename, fileDir);
console.log("文件路径对象", filePathObj);

let filePathArr = fsUtil.getFilePathArr(filePathObj.fileDirname);
console.log("获取目录下的所有文件路径", filePathArr);

let filenameArr = fsUtil.getFilenameArr(filePathObj.fileDirname);
console.log("获取目录下的所有文件名称", filenameArr);

// fsUtil.unlink(filename, fileDir);

Readme

Keywords

Package Sidebar

Install

npm i hys-fs-util

Weekly Downloads

3

Version

1.0.0

License

ISC

Unpacked Size

16.5 kB

Total Files

8

Last publish

Collaborators

  • hys-gk