# micro-fs

> File system and globbing utilities

Latest version **1.0.3** (published 2019-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install micro-fs
pnpm add micro-fs
yarn add micro-fs
bun add micro-fs
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-09-19 |
| First published | 2019-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.5.0 |
| Dependencies | 2 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | d-band |
| Maintainers | d-band |
| Keywords | glob, fs, file-system, copy, cp, move, mv, rm, delete, mkdir, archive, zip |

## Links

- npm: https://www.npmjs.com/package/micro-fs
- Repository: https://github.com/d-band/micro-fs
- Homepage: https://github.com/d-band/micro-fs#readme
- Issues: https://github.com/d-band/micro-fs/issues
- npm.io page: https://npm.io/package/micro-fs

## Dependencies (2)

- [yazl](https://npm.io/package/yazl.md) ^2.5.1
- [glob-stream](https://npm.io/package/glob-stream.md) ^6.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-09-19
- 1.0.2 — 2019-08-08
- 1.0.1 — 2019-08-07
- 1.0.0 — 2019-08-06
- 1.0.0-beta — 2019-08-06

## README

micro-fs
========

> File system and globbing utilities

[![NPM version](https://img.shields.io/npm/v/micro-fs.svg)](https://www.npmjs.com/package/micro-fs)
[![NPM downloads](https://img.shields.io/npm/dm/micro-fs.svg)](https://www.npmjs.com/package/micro-fs)
[![Build Status](https://travis-ci.org/d-band/micro-fs.svg?branch=master)](https://travis-ci.org/d-band/micro-fs)
[![Coverage Status](https://coveralls.io/repos/github/d-band/micro-fs/badge.svg?branch=master)](https://coveralls.io/github/d-band/micro-fs?branch=master)
[![Dependency Status](https://david-dm.org/d-band/micro-fs.svg)](https://david-dm.org/d-band/micro-fs)
[![Greenkeeper badge](https://badges.greenkeeper.io/d-band/micro-fs.svg)](https://greenkeeper.io/)

---

## Install

```bash
$ npm install micro-fs -S
```

## Usage

```js
const mfs = require('micro-fs');

mfs.copy('src/**/*.js', 'lib').then(() => {
  console.log('copy done.');
});

mfs.move('src/**/*.js', 'lib').then(() => {
  console.log('move done.');
});

mfs.delete('dist/**').then(() => {
  console.log('delete done.');
});

mfs.zip('src/**/*.js', 'source.zip').then(() => {
  console.log('archive done.');
});

mfs.glob('src/**/*.js', options).then(files => {
  console.log(files);
  /**
   * [{ cwd, base, path }]
   */
});
```

## API

- `mfs.copy(src, dest, options) => Promise`
- `mfs.move(src, dest, options) => Promise`
- `mfs.zip(src, dest, options) => Promise`
- `mfs.glob(src, options) => Promise`
- `mfs.delete(src, options) => Promise`

> `src` is globs and `options` are documented in [glob-stream](https://www.npmjs.com/package/glob-stream).

## Report a issue

* [All issues](https://github.com/d-band/micro-fs/issues)
* [New issue](https://github.com/d-band/micro-fs/issues/new)

## License

micro-fs is available under the terms of the MIT License.

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