Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/narazaka/fso
fso - FileSystemObject is a objective fs interface like Pathname(ruby).
https://github.com/narazaka/fso
filesystem filesystem-library filesystems pathname
Last synced: about 1 month ago
JSON representation
fso - FileSystemObject is a objective fs interface like Pathname(ruby).
- Host: GitHub
- URL: https://github.com/narazaka/fso
- Owner: Narazaka
- Created: 2014-12-03T05:11:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T20:28:51.000Z (over 4 years ago)
- Last Synced: 2024-11-26T13:14:32.403Z (about 1 month ago)
- Topics: filesystem, filesystem-library, filesystems, pathname
- Language: JavaScript
- Homepage:
- Size: 425 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
[fso - FileSystemObject](https://github.com/Narazaka/fso)
==========================
[](https://www.npmjs.com/package/fso)
[](https://www.npmjs.com/package/fso)
[](https://www.npmjs.com/package/fso)
[](https://www.npmjs.com/package/fso)
[](https://david-dm.org/Narazaka/fso)
[](https://david-dm.org/Narazaka/fso?type=dev)
[](https://travis-ci.org/Narazaka/fso)
[](https://ci.appveyor.com/project/Narazaka/fso)
[](https://codecov.io/github/Narazaka/fso?branch=master)
[](https://codeclimate.com/github/Narazaka/fso)
[](https://www.codacy.com/app/narazaka/fso?utm_source=github.com&utm_medium=referral&utm_content=Narazaka/fso&utm_campaign=badger)
[](https://greenkeeper.io/)
fso - FileSystemObject is a objective fs interface like Pathname(ruby).
Installation
--------------------------
```
npm install fso
```
Usage
--------------------------
node.js:
```javascript
var fso = require('fso').default;
var FileSystemObject = require('fso').FileSystemObject;
```
ES2015:
```javascript
import fso, {FileSystemObject} from 'fso';
```
API
--------------------------
[API Documents (with type annotations)](https://narazaka.github.io/fso/index.html)
### objective methods
#### constructor
```javascript
var abc = new FileSystemObject("a", "b", "c");
abc.toString() === "a/b/c"
```
#### new / join
```javascript
dir = fso.new('dir');
a = dir.new('a.txt');
a.writeFileSync('aaaaaa');
```
#### parent
```javascript
dir = fso.new('dir');
p = dir.parent();
dir = p.new('dir');
```
#### children, childrenSync
```javascript
dir = fso.new('dir');
files = dir.childrenSync();
```
#### childrenAll, childrenAllSync
```javascript
dir = fso.new('dir');
files = dir.childrenAllSync();
```
#### filteredChildren, filteredChildrenSync, filteredChildrenAll, filteredChildrenAllSync
```javascript
excepts = ["ignore_file", "path/to/ignore_directory"];
entries = target.filteredChildrenAllSync(excepts);
```
```javascript
// Sync
excepts = (entry) => entry.isDirectorySync();
files = target.filteredChildrenAllSync(excepts); // childrenSync() minus directories
```
```javascript
// Promise form condition also OK when Promise form call
excepts = (entry) => entry.isDirectory();
files = await target.filteredChildrenAll(excepts);
```
```javascript
// callback form also OK when callback form call
excepts = (entry, callback) =>
entry.isDirectory(
(error, isDirectory) => callback(error, isDirectory)
);
target.filteredChildrenAll(excepts, (error, files) => console.log(files.toString()));
```
### path
#### path / toString
```javascript
fooPath = fso.new('foo').path;
fooPath = fso.new('foo').toString();
```
### 'fs' API
Supports all the node.js 'fs' APIs that needs no first path argument.
`method(...args, callback)`, `methodSync(...args)` and `promise = method(...args)`
#### one file args
```javascript
fs.truncateSync('/path/to/file', 0);
// is
file = fso.new('/path/to/file');
file.truncateSync(0);
```
#### two file args
```javascript
fs.rename('/path/to/file', 'newfile', callback);
// is
file = fso.new('/path/to/file');
file.remane('newfile', callback);
```
#### fd args
```javascript
fd = fs.openSync('/path/to/file');
fs.ftruncateSync(fd, 0);
fs.close(fd);
// is
file = fso.new('/path/to/file');
file.openSync();
file.ftruncateSync(0);
file.close();
```
### convenient additional
#### mkdirAll
```javascript
fso.new('long/deep/path/to').mkdirAll().then(...);
```
#### mkdirp (= mkdirAll)
#### mkpath (= mkdirAll)
#### readdirAll
```javascript
dir.readdirAllSync()
// results
['a.txt', 'aa', 'aa/a.txt', 'aa/b', 'aa/b/c.txt']
```
#### rmAll
```javascript
await dir.rmAll('junk');
```
#### rmtree (= rmAll)
#### mergeDirectory
```javascript
target.mergeDirectory(source);
```
copy:
```javascript
target.rmAllSync();
target.mergeDirectorySync(source);
```
#### filteredMergeDirectory
```javascript
excepts = ["ignore_file", "path/to/ignore_directory"];
target.filteredMergeDirectorySync(source, excepts);
```
```javascript
excepts = (entry) => entry.path === "ignore_file" || entry.path === "path/to/ignore_directory";
target.filteredMergeDirectorySync(source, excepts);
```
#### isChildOf
```javascript
dir.new("foo/bar").isChildOf(dir)
```
#### isParentOf
```javascript
dir.isParentOf(dir.new("foo/bar"))
```
### path methods
#### (property) delimiter
```javascript
fso.delimiter; // ":" or ";"
```
#### (property) sep
```javascript
fso.sep; // "/" or "\\"
```
#### (static) format
```javascript
var entry = FileSystemObject.format({...});
```
#### parse
```javascript
var parsedObject = fso.new("a").parse();
```
#### normalize
```javascript
fso.new("a").normalize(); // same as fso.new("a")
```
#### basename
```javascript
fso.new("a/b/c").basename(); // same as new FileSystemObject("c")
```
#### dirname
same as parent()
#### extname
```javascript
fso.new("a/b/c.txt").extname(); // ".txt"
```
#### isAbsolute
```javascript
fso.new("a/b/c.txt").isAbsolute() === true
```
#### relative
```javascript
fso.new("a/b/c").relative(fso.new("a/d")); // same as new FileSystemObject("../d")
fso.new("/a/b/c").relative("/a/d"); // same as new FileSystemObject("../d")
```
#### resolve
```javascript
fso.new("a/b/c").resolve("/") // same as new FileSystemObject("/a/b/c")
```
License
--------------------------
This is released under [Zlib License](http://narazaka.net/license/Zlib?2020).