https://github.com/orcunsaltik/njfs

A collection of Node.js filesystem functions.
https://github.com/orcunsaltik/njfs

asynchronous copy directory file filesystem folder folders javascript js list move node node-js nodejs root unix

Last synced: 9 days ago
JSON representation

A collection of Node.js filesystem functions.

• Host: GitHub
• URL: https://github.com/orcunsaltik/njfs
• Owner: orcunsaltik
• License: mit
• Created: 2020-06-26T21:22:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-15T17:36:25.000Z (over 3 years ago)
• Last Synced: 2024-04-25T11:43:03.462Z (7 months ago)
• Topics: asynchronous, copy, directory, file, filesystem, folder, folders, javascript, js, list, move, node, node-js, nodejs, root, unix
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/njfs
• Size: 32.2 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node Js File System

[![Build Status](https://travis-ci.com/orcunsaltik/njfs.svg?branch=master)](https://travis-ci.com/orcunsaltik/njfs)

[![devDependencies Status](https://david-dm.org/orcunsaltik/njfs/dev-status.svg)](https://david-dm.org/orcunsaltik/njfs?type=dev)

[![Maintainability](https://api.codeclimate.com/v1/badges/035ff3499e767eb6b552/maintainability)](https://codeclimate.com/github/orcunsaltik/njfs/maintainability)

![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/orcunsaltik/njfs)

![npm](https://img.shields.io/npm/dt/njfs)

[![NPM Version](https://badge.fury.io/js/njfs.svg?style=flat)](https://npmjs.org/package/njfs)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/orcunsaltik/njfs/issues)

A small collection of sync & async filesystem functions for Node Js. 

## Install

``` bash

npm install --save-dev njfs

```

## Methods

1. unix(path): Synchronous. Returns path with unix-like directory separators.

2. root(path): Synchronous. Returns the root directory of the package.

3. list(path, opts): Asynchronous. Returns the list of files and folders of the given path.

4. move(path, dest): Asynchronous. Moves files or folders.

5. copy(path, dest): Asynchronous. Copies files or folders.

6. isFile(path): Synchronous. Checks whether the specified path is an existing file or not.

7. isDir(path): Synchronous. Checks whether the specified path is an existing directory or not.

## Usage

``` js

const {move, copy, root, list, isDir} = require('njfs');

gulp.task('example', async () =>

    await gulp.watch(['./src/*.*'], gulp.series('build', async () => {

        const dist = root() + 'src';

        const dest = root() + 'dist/js';

        try {

            const files = await list(dist, {extensions:'js, jsx'});

            await Promise.all(files.map(async (file) => {

                const path = `${dist}/${file}`;

                if (!isDir(path)) {

                    await copy(path, dest);

                    console.log(`${file} transfered to ${dest}`);

                }

            }));

        } catch (e) {

            console.log(e);

        }

    })

));

```

## Troubleshooting

When you encounter a problem, please open an issue. I would be glad to help you to find a solution if possible.

## Author

Github: [@orcunsaltik](https://github.com/orcunsaltik)

## License

See the [LICENSE](LICENSE) file for license rights and limitations (MIT).