https://github.com/nknapp/m-io

(Incomplete) replacement for `q-io`
https://github.com/nknapp/m-io
Last synced: 3 months ago
JSON representation
(Incomplete) replacement for `q-io`
Host: GitHub
URL: https://github.com/nknapp/m-io
Owner: nknapp
License: mit
Created: 2016-07-22T13:21:15.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2017-02-15T20:33:25.000Z (over 8 years ago)
Last Synced: 2025-03-25T18:55:40.081Z (3 months ago)
Language: JavaScript
Size: 30.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project

README

        # m-io 

[![NPM version](https://badge.fury.io/js/m-io.svg)](http://badge.fury.io/js/m-io)

[![Travis Build Status](https://travis-ci.org/nknapp/m-io.svg?branch=master)](https://travis-ci.org/nknapp/m-io)

[![Coverage Status](https://img.shields.io/coveralls/nknapp/m-io.svg)](https://coveralls.io/r/nknapp/m-io)

> (Incomplete) replacement for q-io

This package is a replacement for the functions of [q-io](https://npmjs.com/package/q-io) that I use in my projects. I have use `q-io/fs` a lot since it has functions

like `makeTree`, `listTree` and `removeTree`. Furthermore, its `read` and `write` function work with strings by default, which makes it easier to 

read text files.

Sadly, `q-io@1` depends on [collections](https://npmjs.com/package/collections)@1, which 

[overwrites the function `Array.prototype.find` with an implementation that does not match the ES6-spec](https://github.com/montagejs/collections/issues/139).

This causes problems in [jsdoc-parse](https://npmjs.com/package/jsdoc-parse). This is another example of why [modifying objects you don’t own][zakas dont modify]

is a bad practice.

This problem *could* be solved by using `q-io@2` instead of version 1. This version has [other problems](https://github.com/kriskowal/q-io/pull/155) which were

solved in version 1. It may be a silly feeling, but version 2 of `q-io` vseems not to receive too much care at the moment.

Since I do not use many functions, I have decided to write a drop-in replacement for my own purposes, and this is it: `m-io`.

If you like this and want to provide more methods for your needs, please go ahead and make a PR.

[zakas dont modify]: https://www.nczonline.net/blog/2010/03/02/maintainable-javascript-dont-modify-objects-you-down-own/

# Installation

```

npm install m-io

```

 

## Usage

The following example demonstrates how to use this module:

```js

var FS = require('m-io/fs')

// Create some files

FS.makeTree('city/germany')

  .then(() => FS.write('city/germany/darmstadt.md', 'Darmstadt is nice'))

  .then(() => FS.makeTree('city/usa'))

  .then(() => FS.write('city/usa/new-york.md', 'New York is huge'))

  .then(() => FS.makeTree('city/france'))

  .then(() => FS.write('city/france/paris.md', 'Olala'))

  // Existance of files

  .then(() => FS.exists('city'))

  .then((exists) => console.log('Directory city exists?', exists))

  .then(() => FS.exists('something-else'))

  .then((exists) => console.log('Directory something-else exists?', exists))

  // Checking for directories

  .then(() => FS.isDirectory('city/germany'))

  .then((isDirectory) => console.log('Is `city/germany` a directory?', isDirectory))

  .then(() => FS.isDirectory('city/germany/darmstadt.md'))

  .then((isDirectory) => console.log('Is `city/germany/darmstadt.md` a directory?', isDirectory))

  .then(() => FS.isDirectory('city/germany/non-existing-file'))

  .then((isDirectory) => console.log('Is `city/germany/non-existing-file` a directory?', isDirectory))

  // Directory listings

  .then(() => FS.list('city'))

  .then((list) => console.log('Directory entries of city', list.sort()))

  // List files

  .then(() => FS.listTree('city', (filename, stats) => stats.isFile()))

  .then((filelist) => console.log('List files:', filelist.sort()))

  // List dirs and files

  .then(() => FS.listTree('city'))

  .then((list) => console.log('List dirs and files:', list.sort()))

  // Read file contents

  .then(() => FS.read('city/usa/new-york.md'))

  .then((nyc) => console.log('Read file contents:', nyc))

  // Remove subdir

  .then(() => FS.removeTree('city/usa'))

  .done(() => console.log('Done'))

```

This will generate the following output

```

Directory city exists? true

Directory something-else exists? false

Is `city/germany` a directory? true

Is `city/germany/darmstadt.md` a directory? false

Is `city/germany/non-existing-file` a directory? false

Directory entries of city [ 'france', 'germany', 'usa' ]

List files: [ 'city/france/paris.md',

  'city/germany/darmstadt.md',

  'city/usa/new-york.md' ]

List dirs and files: [ 'city',

  'city/france',

  'city/france/paris.md',

  'city/germany',

  'city/germany/darmstadt.md',

  'city/usa',

  'city/usa/new-york.md' ]

Read file contents: New York is huge

Done

```

After deleting `city/usa`, the `city`-subtree looks liks this:



city

├─┬ france

│ └── paris.md

└─┬ germany

  └── darmstadt.md



##  API-reference 

### `require("m-io/fs")`



## fs

* [fs](#module_fs)

    * [.exists(existsPath)](#module_fs.exists) ⇒ Promise.<boolean>

    * [.listTree(directoryPath, filter)](#module_fs.listTree) ⇒ Promise.<Array.<string>>

    * [.list(directoryPath)](#module_fs.list) ⇒ Promise.<Array.<string>>

    * [.makeTree(aPath, [mode])](#module_fs.makeTree)

    * [.read(aPath)](#module_fs.read)

    * [.write(aPath, content)](#module_fs.write)

    * [.copy(source, target)](#module_fs.copy)

    * [.copyTree(source, target)](#module_fs.copyTree)

    * [.stat(aPath)](#module_fs.stat)

    * [.isDirectory(directory)](#module_fs.isDirectory)



### fs.exists(existsPath) ⇒ Promise.<boolean>

Custom implementation of [q-io/fs#exists](http://documentup.com/kriskowal/q-io#lexistsPath)

to avoid dependency on q-io

**Kind**: static method of [fs](#module_fs)  

**Returns**: Promise.<boolean> - a promise for the existance (true/false) of the file/dir at the path  

| Param | Type | Description |

| --- | --- | --- |

| existsPath | string | the path to check |



### fs.listTree(directoryPath, filter) ⇒ Promise.<Array.<string>>

Custom implementation of [q-io/fs#listTree](http://documentup.com/kriskowal/q-io#listtreepath-guardpath-stat)

to avoid dependency on q-io

**Kind**: static method of [fs](#module_fs)  

**Returns**: Promise.<Array.<string>> - a promise for the collector, that is fulfilled after traversal  

| Param | Type | Description |

| --- | --- | --- |

| directoryPath | string | the base path |

| filter | function | a function that returns true, false or null to show that a file  should be included or ignored and that a directory should be ignored completely (null) |



### fs.list(directoryPath) ⇒ Promise.<Array.<string>>

Custom implementation of [q-io/fs#list](http://documentup.com/kriskowal/q-io#listpath)

to avoid dependency on q-io

**Kind**: static method of [fs](#module_fs)  

**Returns**: Promise.<Array.<string>> - a promise for the collector, that is fulfilled with a list of directory entries  

| Param | Type | Description |

| --- | --- | --- |

| directoryPath | string | the base path |



### fs.makeTree(aPath, [mode])

Replacement for [q-io/fs#makeTree](http://documentup.com/kriskowal/q-io#maketreepath-mode)

**Kind**: static method of [fs](#module_fs)  

| Param | Type | Description |

| --- | --- | --- |

| aPath | string | the directory to be created |

| [mode] | number | (e.g. 0644) |



### fs.read(aPath)

Replacement for [q-io/fs#read](http://documentup.com/kriskowal/q-io#readpath-options)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| aPath | 



### fs.write(aPath, content)

Replacement for [q-io/fs#write](http://documentup.com/kriskowal/q-io#writepath-content-options)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| aPath | 

| content | 



### fs.copy(source, target)

Replacement for [q-io/fs#copy](http://documentup.com/kriskowal/q-io#copysource-target)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| source | 

| target | 



### fs.copyTree(source, target)

Replacement for [q-io/fs#copyTree](http://documentup.com/kriskowal/q-io#copytreesource-target)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| source | 

| target | 



### fs.stat(aPath)

Replacement for [q-io/fs#stat](http://documentup.com/kriskowal/q-io#statpath)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| aPath | 



### fs.isDirectory(directory)

Replacement for [q-io/fs#isDirectory](http://documentup.com/kriskowal/q-io#isdirectorypath)

**Kind**: static method of [fs](#module_fs)  

| Param |

| --- |

| directory | 

## License

`m-io` is published under the MIT-license. 

See [LICENSE.md](LICENSE.md) for details.

## Release-Notes

 

For release notes, see [CHANGELOG.md](CHANGELOG.md)

 

## Contributing guidelines

See [CONTRIBUTING.md](CONTRIBUTING.md).
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/nknapp/m-io

Awesome Lists containing this project

README
