# directory-list

> Lists a directory's contents

Latest version **1.1.1** (published 2016-08-27) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install directory-list
pnpm add directory-list
yarn add directory-list
bun add directory-list
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-08-27 |
| First published | 2016-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Simon Meusel |
| Maintainers | simonmeusel |
| Keywords | Directory, List, html, folder, watch |

## Links

- npm: https://www.npmjs.com/package/directory-list
- Repository: https://github.com/simonmeusel/directory-list
- Homepage: https://github.com/simonmeusel/directory-list#readme
- Issues: https://github.com/simonmeusel/directory-list/issues
- npm.io page: https://npm.io/package/directory-list

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-08-27
- 1.1.0 — 2016-08-26
- 1.0.0 — 2016-08-21

## README

# directory-list
Lists a directory's contents

## Usage

```javascript
const dl = require('directory-list');

dl.list(__dirname, false, function(files) {
  console.log('The existing files are ' + files);
});
```

```javascript
const dl = require('directory-list');

dl.watch(__dirname, false, function(files) {
  console.log('The existing files are ' + files);
}, true);
```

## Documentation

### Methods

#### list(directory, onlyDirectories, callback)

* `directory` - directory to list
* `onlyDirectories` - should files be ignored
* `callback` (files) - callback

#### watch(directory, onlyDirectories, callback, start)

Calls `list(directory, onlyDirectories, callback)` whenever a file changes in the directory.

* `directory` - directory to list
* `onlyDirectories` - should files be ignored
* `callback` (files) - callback
* `start` - should list be called once at start

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