mirror of
https://github.com/gnh1201/welsonjs.git
synced 2025-05-14 13:41:05 +00:00
48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
# File - Common higher level file and path operations
|
|
|
|
## Install
|
|
|
|
<pre>
|
|
npm install file
|
|
</pre>
|
|
|
|
<pre>
|
|
var file = require("file");
|
|
</pre>
|
|
|
|
## API
|
|
|
|
### file.walk(start, callback)
|
|
|
|
Navigates a file tree, calling callback for each directory, passing in (null, dirPath, dirs, files).
|
|
|
|
|
|
### file.walkSync(start, callback)
|
|
|
|
Synchronus version of file.walk, calling callback for each directory, passing in (dirPath, dirs, files).
|
|
|
|
|
|
### file.mkdirs(path, mode, callback)
|
|
|
|
Makes all the directories in a path. (analgous to mkdir -P) For example given a path like "test/this/path" in an empty directory, mkdirs would make the directories "test", "this" and "path".
|
|
|
|
|
|
### file.mkdirsSync(path, mode)
|
|
|
|
Like file.mkdirs but synchronous.
|
|
|
|
|
|
### file.path.abspath(path)
|
|
|
|
Expands ".", "..", "~" and non root paths to their full absolute path. Relative paths default to being children of the current working directory.
|
|
|
|
|
|
### file.path.relativePath(root, fullPath)
|
|
|
|
Given a root path, and a fullPath attempts to diff between the two to give us an acurate path relative to root.
|
|
|
|
|
|
### file.path.join(head, tail)
|
|
|
|
Just like path.join but haves a little more sanely when give a head equal to "". file.path.join("", "tail") returns "tail", path.join("", "tail") returns "/tail"
|