Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taufik-nurrohman/folder
Folder system utility.
https://github.com/taufik-nurrohman/folder
folder helper node utility
Last synced: 17 days ago
JSON representation
Folder system utility.
- Host: GitHub
- URL: https://github.com/taufik-nurrohman/folder
- Owner: taufik-nurrohman
- License: mit
- Created: 2020-12-18T02:33:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-01T13:13:56.000Z (over 2 years ago)
- Last Synced: 2024-05-02T00:23:22.253Z (6 months ago)
- Topics: folder, helper, node, utility
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Folder Utility
==============
Utility functions of native folder system API in Node.js. Not to be used in the browser.
Usage
-----
### CommonJS
~~~ js
const {getContent} = require('@taufik-nurrohman/folder');
console.log(getContent('./node_modules', 1, true));
~~~
### ECMAScript
~~~ js
import {getContent} from '@taufik-nurrohman/folder';
console.log(getContent('./node_modules', 1, true));
~~~
Methods
-------
### copy(from, to, name)
Copy a folder with its contents.
~~~ js
copy('./node_modules', './foo/bar/baz');
copy('./node_modules', './foo/bar/baz', 'node_modules.bak');
~~~
### get(path)
Check if file/folder does exist.
~~~ js
if (false !== get('./node_modules')) {
// …
}
~~~
### getContent(path, x = null, deep = 0)
List all files and folders in a folder as object.
~~~ js
// List file(s) only
console.log(getContent('./node_modules', 1));
// List folder(s) only
console.log(getContent('./node_modules', 0));
// List file(s) only with extension `.js`
console.log(getContent('./node_modules', 'js'));
// List file(s) only with extension `.js` and `.mjs`
console.log(getContent('./node_modules', 'js,mjs'));
// List file(s) only with extension `.js` and `.mjs` recursively
console.log(getContent('./node_modules', 'js,mjs', true));
// List file(s)/folder(s) with custom filter
console.log(getContent('./node_modules', (value, key) => {
return 1 === value && '.min.js' !== key.slice(-7);
}, true));
~~~
### isFolder(path)
Check if path is a folder.
~~~ js
if (false !== isFolder('./foo/bar/baz')) {
// …
}
~~~
### move(from, to, name)
Delete or move a folder with its contents.
~~~ js
// Delete
move('./node_modules', false);
// Delete
move('./node_modules');
// Move
move('./node_modules', './foo/bar/baz');
// Move
move('./node_modules', './foo/bar/baz', 'node_modules.bak');
~~~
### name(path)
Get folder name from folder path.
~~~ js
console.log(name('./foo/bar/baz'));
console.log(name('./foo/bar/baz.qux'));
~~~
### parent(path)
Get parent path from folder path.
~~~ js
console.log(parent('./foo/bar/baz'));
console.log(parent('./'));
console.log(parent('.'));
console.log(parent(""));
~~~
### set(path, deep = false)
Create an empty folder if it does not exist.
~~~ js
set('./foo/bar/baz', true);
~~~