# simple-file-list

> simple file walker that list files

Latest version **1.0.1** (published 2017-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-file-list
pnpm add simple-file-list
yarn add simple-file-list
bun add simple-file-list
```

## 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.1 |
| Published | 2017-03-28 |
| First published | 2017-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kim@morgondag.nu |
| Maintainers | morgondag |
| Keywords | file, walker |

## Links

- npm: https://www.npmjs.com/package/simple-file-list
- npm.io page: https://npm.io/package/simple-file-list

## 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.1 (latest) — 2017-03-28
- 1.0.0 — 2017-03-28

## README

# simple-file-list
Reads a folder, list all files, can save to disk.


### **require**
as a regular node-module

* ```npm i simple-file-list --save```

```js
const sfl = require('simple-file-list')

// list all files
sfl('./folder').then(result => {
	console.log(result)
})

// list all files matching with png
sfl('./folder', 'png').then(result => {
	console.log(result)
})

// list all files matching png and save to list.json
sfl('./folder', 'png, 'list.json).then(result => {
	console.log(result)
})

```



### **cli**
run from terminal

* ```npm i -g simple-file-list```

```bash
$ simple-file-list ./folder
or
$ simple-file-list ./folder png
or
$ simple-file-list ./folder png list.json
```

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