Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/floatdrop/stream-dirs

Streams directories as path and stat objects
https://github.com/floatdrop/stream-dirs

Last synced: 22 days ago
JSON representation

Streams directories as path and stat objects

Awesome Lists containing this project

README

        

# stream-dirs [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency Status][depstat-image]][depstat-url]

Reads all directories in path (without hidden - that begins with dot).

## Usage

```js
var readdir = require('stream-dirs');
readdir('./').on('data', console.log);
```

## API

### stream-dirs(path)

Returns Stream of objects, that have `path` and `stat` properties.

## License

MIT (c) 2014 Vsevolod Strukchinsky

[npm-url]: https://npmjs.org/package/stream-dirs
[npm-image]: https://badge.fury.io/js/stream-dirs.png

[travis-url]: http://travis-ci.org/floatdrop/stream-dirs
[travis-image]: https://travis-ci.org/floatdrop/stream-dirs.png?branch=master

[depstat-url]: https://david-dm.org/floatdrop/stream-dirs
[depstat-image]: https://david-dm.org/floatdrop/stream-dirs.png?theme=shields.io

[coveralls-url]: https://coveralls.io/r/floatdrop/stream-dirs
[coveralls-image]: https://coveralls.io/repos/floatdrop/stream-dirs/badge.png