# filedir

> 一个支持多层级创建目录和读写文件的模块

Latest version **1.0.2** (published 2024-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install filedir
pnpm add filedir
yarn add filedir
bun add filedir
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-09-12 |
| First published | 2017-01-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.0.0 |
| Dependencies | 0 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | tanfurui |
| Maintainers | tanfurui |
| Keywords | file, folder, dir, directory |

## Links

- npm: https://www.npmjs.com/package/filedir
- npm.io page: https://npm.io/package/filedir

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2024-09-12
- 1.0.1 — 2017-03-13
- 1.0.0 — 2017-01-01

## README

## What is webextlib? 什么是filedir？
* filedir is a module that supports multi-level directory creation and file reading and writing. filedir是一个支持多层级创建目录和读写文件的模块。

## Function 功能
* Create directory 创建目录
* Delete file or directory 删除文件或目录
* Copy file 复制文件
* Read file 读取文本文件
* Write file 写文本文件
* Write JSON file JSON变量写出到json文件，若目录不存在则自动创建
* Determine whether the file or directory exists 判断文件或目录是否存在
* Determine if it is an existing file 判断是不是一个已存在的文件
* Determine if it is an existing directory 判断是不是一个已存在的目录

## Install 安装
> npm i -g filedir

## Upgrade Instructions 升级说明
#### 1.0.2
* Supports require and import calls. 支持require和import调用。
* Added d.ts type declaration prompt. 增加了d.ts类型声明提示。
#### 1.0.1
* Added usage instructions. 添加了使用说明。

## Usage 使用
#### require
```js
const filedir = require('filedir');
filedir.mkdir('D:/filedirTest');
// filedir.del('D:/filedirTest');
filedir.copy('D:/a.txt', 'D:/b.txt');
console.log('read', filedir.read('D:/filedirTest.txt'));
filedir.write('D:/filedir_write.txt', '0123456789');
filedir.writeJsonFile('D:/filedir_json.txt', {Color:'Blue'});
console.log('isExist', filedir.isExist('D:/filedir_write.txt'));
console.log('isFile', filedir.isFile('D:/filedirTest'));
console.log('isDir', filedir.isDir('D:/filedirTest'));
```
#### import
```js
import {mkdir, del, copy, read, write, writeJsonFile, isExist, isFile, isDir} from 'filedir';
mkdir('D:/filedirTest');
// del('D:/filedirTest');
copy('D:/a.txt', 'D:/b.txt');
console.log('read', read('D:/filedirTest.txt'));
write('D:/filedir_write.txt', '0123456789');
writeJsonFile('D:/filedir_json.txt', {Color:'Blue'});
console.log('isExist', isExist('D:/filedir_write.txt'));
console.log('isFile', isFile('D:/filedirTest'));
console.log('isDir', isDir('D:/filedirTest'));
```

---
_Source: https://npm.io/package/filedir · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._