# fx58-node

> An elegant solution to list files

Latest version **1.0.5** (published 2018-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install fx58-node
pnpm add fx58-node
yarn add fx58-node
bun add fx58-node
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2018-02-14 |
| First published | 2018-01-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mgen |
| Maintainers | mgenware |
| Keywords | list files, file system |

## Links

- npm: https://www.npmjs.com/package/fx58-node
- Repository: https://github.com/mgenware/fx58-node
- Issues: https://github.com/mgenware/fx58-node/issues
- npm.io page: https://npm.io/package/fx58-node

## Dependencies (1)

- [m-fs](https://npm.io/package/m-fs.md) ^1.0.3

## Recent versions

- 1.0.5 (latest) — 2018-02-14
- 1.0.4 — 2018-01-16
- 1.0.3 — 2018-01-16
- 1.0.2 — 2018-01-16
- 1.0.1 — 2018-01-16
- 1.0.0 — 2018-01-16

## README

# fx58-node

[![MEAN Module](https://img.shields.io/badge/MEAN%20Module-TypeScript-blue.svg)](https://github.com/mgenware/MEAN-Module)
[![Build Status](https://travis-ci.org/mgenware/fx58-node.svg?branch=master)](http://travis-ci.org/mgenware/fx58-node)
[![npm version](https://badge.fury.io/js/fx58-node.svg)](https://badge.fury.io/js/fx58-node)
[![Node.js Version](http://img.shields.io/node/v/fx58-node.svg)](https://nodejs.org/en/)

An elegant solution to list files

## Installation
```sh
# yarn
yarn add fx58-node

# npm
npm install --save fx58-node
```

Run tests:
```sh
# yarn
yarn test

# npm
npm test
```

## API
```javascript
import listAsync from 'fx58-node';
// or Node.js style: const listAsync = require('fx58-node').default;

const files = await listAsync(
  directory,  // the path of directory
  recursive,  // defaults to false
  fileFilter, // file filter, defaults to null
  dirFiler,   // directory filter, defaults to null
);
```

## Example
Assume a directory like this:
```
data
├── .DS_Store
├── .sys
│   ├── t.json
│   └── t.txt
├── .sys.json
├── a
│   ├── .sys.json
│   ├── t.json
│   └── t.txt
├── t.json
└── t.txt
```

```javascript
import listAsync from 'fx58-node';

(async () => {
  let files = [];
  files = await listAsync('./data');
  console.log(files);
  /* 
  [ 'data/.DS_Store',
    'data/.sys.json',
    'data/t.json',
    'data/t.txt' ]
  */

  files = await listAsync('./data', true);
  console.log(files);
  /* 
  [ 'data/.DS_Store',
    'data/.sys.json',
    'data/t.json',
    'data/t.txt',
    'data/.sys/t.json',
    'data/.sys/t.txt',
    'data/a/.sys.json',
    'data/a/t.json',
    'data/a/t.txt' ]
  */

  files = await listAsync('./data', true, (file) => {
    return /.*\.txt$/i.test(file) && !file.startsWith('.');
  });
  console.log(files);
  /*
    [ 'data/t.txt', 'data/.sys/t.txt', 'data/a/t.txt' ]
  */

  files = await listAsync('./data', true,
  (file) => {
    return /.*\.txt$/i.test(file) && !file.startsWith('.');
  },
  (dir) => {
    return !dir.startsWith('.');
  });
  console.log(files);
  /*
    [ 'data/t.txt', 'data/a/t.txt' ]
  */

})();
```

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