# directories

> Retrieve the directory names within a chosen directory

Latest version **1.0.1** (published 2015-06-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `directories`.

## 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 | 2015-06-08 |
| First published | 2015-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | james@womack.io |
| Maintainers | jameswomack |
| Keywords | directories, directory, dir, readdir, object, hierarchy, format, exclude, only |

## Links

- npm: https://www.npmjs.com/package/directories
- Repository: https://github.com/jameswomack/node-directories
- Homepage: https://github.com/jameswomack/node-directories#readme
- Issues: https://github.com/jameswomack/node-directories/issues
- npm.io page: https://npm.io/package/directories

## Dependencies (3)

- [async](https://npm.io/package/async.md) 1.2.0
- [isobject](https://npm.io/package/isobject.md) 1.0.0
- [is-function](https://npm.io/package/is-function.md) 1.0.1

## 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.1 (latest) — 2015-06-08
- 1.0.0 — 2015-06-08

## README

# node-directories
Directory names within a path, returned in many formats. Node.js FTW.

## API
```
var dir = new Directories(process.cwd())
dir.get(function(error, directoryNames) {
  console.info(directoryNames) // [ '.git', 'bin', 'lib', 'node_modules', 'test' ]
})
```
Please see test/test.js for more examples

## Getting Started
```
npm i
npm run cover
```

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