Atom

Represents a directory on disk that can be watched for changes.

Configures a new Directory instance, no files are accessed.

directoryPath

A String containing the absolute path to the directory

symlink

optional

A Boolean indicating if the path is a symlink. (default: false)

Creates the directory on disk that corresponds to ::getPath() if no such directory already exists.

mode

optional

Number that defaults to 0777.

Returns a Promise that resolves once the directory is created on disk. It resolves to a boolean value that is true if the directory was created or false if it already existed.

Invoke the given callback when the directory's contents change.

callback()

Function to be called when the directory's contents change.

Returns a Disposable on which .dispose() can be called to unsubscribe.

Returns a Boolean, always false.

Returns a Boolean, always true.

Returns a Boolean indicating whether or not this is a symbolic link

Returns a promise that resolves to a Boolean, true if the directory exists, false otherwise.

Returns a Boolean, true if the directory exists, false otherwise.

Return a Boolean, true if this Directory is the root directory of the filesystem, or false if it isn't.

This may include unfollowed symlinks or relative directory entries. Or it may be fully resolved, it depends on what you give it.

Returns the directory's String path.

All relative directory entries are removed and symlinks are resolved to their final destination.

Returns this directory's completely resolved String path.

Returns the String basename of the directory.

Returns the relative String path to the given path from this directory.

Traverse to the parent directory.

Returns a Directory.

Traverse within this Directory to a child File. This method doesn't actually check to see if the File exists, it just creates the File object.

filename

The String name of a File within this Directory.

Returns a File.

Traverse within this a Directory to a child Directory. This method doesn't actually check to see if the Directory exists, it just creates the Directory object.

dirname

The String name of the child Directory.

Returns a Directory.

Reads file entries in this directory from disk synchronously.

Returns an Array of File and Directory objects.

Reads file entries in this directory from disk asynchronously.

callback(error, entries)

A Function to call with the following arguments:

error

An Error, may be null.

entries

An Array of File and Directory objects.

Determines if the given path (real or symbolic) is inside this directory. This method does not actually check if the path exists, it just checks if the path is under this directory.

pathToCheck

The String path to check.

Returns a Boolean whether the given path is inside this directory.

Directory extended

Construction

::constructor(directoryPath, [symlink])

::create([mode])

Event Subscription

::onDidChange(callback)

Directory Metadata

::isFile()

::isDirectory()

::isSymbolicLink()

::exists()

::existsSync()

::isRoot()

Managing Paths

::getPath()

::getRealPathSync()

::getBaseName()

::relativize()

Traversing

::getParent()

::getFile(filename)

::getSubdirectory(dirname)

::getEntriesSync()

::getEntries(callback)

::contains(pathToCheck)