Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 138 lines (102 sloc) 3.185 kb

Pathname

Summary

OOP wrapper for fs, path and Stat functions.

Simple, clear and concise way to manipulate paths, files and directories. Inspired by the Ruby stdlib class of the same name.

Features

  • Unified Sync/Async API
  • Direct mapping of core nodejs functions, so that API is consistent and intuitive
  • Returns this when possible, allowing for method chaining
  • Additional convenience methods

Install

$ npm install pathname

And in your app:

var Pathname = require("pathname").Pathname;

Examples

Unified Sync/Async API

Pathname abstracts away the funcname() vs funcnameSync() distiction made in core nodejs fs functions, and substitutes it for an intuitive equivalent; when called with a callback, the function is async - when called without a callback, it is synchronous.

var path = 'tmp/foo.txt'; // contents: "bar"

// async
fs.readFile(path, function(data) {
    data; // 'bar'
});
new Pathname(path).readFile(function (data) {
    data; // 'bar'
});

// sync
fs.readFileSync(path);         // 'bar'
new Pathname(path).readFile(); // 'bar'

Notice the sync version doesn't end with Sync.

Direct Mapping

All functions provided by the path, fs and Stat modules are available on Pathname, and they all take the exact same arguments, with the exception that an initial path or file descriptor argument is always implicit.

// path functions
path.basename()
path.dirname()
path.extname()
path.exists()
// ...

// Stat functions
path.isFile()
path.isDirectory()
path.isSymbolicLink()
// ...

// fs functions
path.readFile()
path.writeFile(data, encoding)
path.watchFile()
path.link(dstpath)
path.mkdir()
// ...

Method Chaining

Methods return this when no other value is expected. In async versions, this is passed as second argument when err would otherwise be the only expected argument. This behaviour allows for chaining of Pathname method calls.

// sync
new Pathname(__dirname ).parent().join('lib/my_module/version');
new Pathname('/tmp/foo').parent().siblings();
new Pathname('/tmp/foo').mkdir().join('bar').touch().watchFile();
new Pathname('/tmp/foo').writeFile('bar').readFile();

// async
new Pathname('/tmp/foo').mkdir(function(err, path) {
    path.join('bar').touch(function(err, path) {
        path.watchFile();
    });
});

Additional Methods

Pathname also provides a few extra methods, which can be quite useful. Especially interesting is the tree() function, which allows walking a directory tree recursively. See the api docs or man pathname for details.

toString(), parent(), children(), siblings(), tree(), touch(), rmR(), mkdirP(), traverse(), components()

Links

Contributors

  • fat
  • Kenji Toyama
Something went wrong with that request. Please try again.