Directory Methods

file(name)

The file() method returns a File object for a file in or under to it.

const web = dir('web');
const logo = web.file('images/logo.png');   // => web/images/logo.png

dir(name)

The dir() method returns a Directory object for a directory in or under it.

const web = dir('web');
const images = web.dir('images');   // => web/images

parent()

The parent() method returns a Directory object representing the parent directory of a directory.

For example, you might have a script in a bin directory in your project and you want to resolve some directories or files relative to the parent directory, i.e. the project base directory.

import { bin } from '@abw/badger-filesystem'

const root = bin().parent();

up(n)

The up(n) method returns a Directory object representing the directory one or more levels above it.

The default value for n is 1, meaning that it does the same thing as the parent() method.

Following on from the previous example, if you have a script in the bin/foo directory and you want to go two levels up to get to the project base directory:

import { bin } from '@abw/badger-filesystem'
const root = bin().up(2);

path()

The path() method returns the current path to the directory.

const web = dir('web');
console.log(web.path());      // => web

const path = web.dir('images');
console.log(images.path());   // => web/images

You can pass an argument to the method to get a path relative to the directory.

const web = dir('web');
const logo = web.path('images/logo.png');   // => web/images/logo.png

Multiple arguments are assumed to be separate path elements.

const web = dir('web');
const logo = web.path('images', 'logo.png');   // => web/images/logo.png

exists()

This asynchronous method checks if the directory exists.

const web = dir('web');
const exists = await web.exists();

mustExist(options)

Asynchronous method to test if the directory exists. If no options are specified then it will return true if the directory exists or throw an error if not.

The mkdir and optionally recursive options can be set to instead have it make the directory (and any intermediate directories when recursive is set). The create option is a short-hand for setting both.

// create the tmp/output directory if it doesn't already exists
const output = await dir('tmp/output').mustExist({ create: true });

isEmpty()

Asynchronous method to test if the directory is empty.

const empty = await dir('foo/bar').isEmpty()

notEmpty()

Asynchronous method to test if the directory is NOT empty.

const full = await dir('foo/bar').notEmpty()

mkdir(options)

Asynchronous method to create the directory.

The recursive option can be specified to have it recursively create any intermediate directories.

await dir('foo/bar').mkdir({ recursive: true })

create()

Asynchronous method to create the directory. It is a wrapper around mkdir() which defaults the recursive flag to true.

rmdir(options)

Asynchronous method to delete the directory.

The empty option can be specified to have it first empty the directory of any files and directories.

The force option can be specified to force the removal of files and directories.

The recursive can be specified to recursively empty and delete sub-directories

await dir('foo/bar').rmdir({ empty: true, recursive: true, force: true })

destroy()

Asynchronous method to empty and delete the directory. It is a wrapper around rmdir() which defaults the empty, force and recursive flag to all be true.

empty(options)

Asynchronous method to empty the directory of any files and directories.

The force option can be specified to force the removal of files and directories.

The recursive can be specified to recursively empty and delete sub-directories

await dir('foo/bar').empty({ recursive: true, force: true })

read()

Asynchronous method to read the directory and return an array of the names of files and directories in it.

const contents = await dir('foo/bar').read()

entries()

Asynchronous method to read the directory and return an array of File and Directory objects representing the contents. Only regular files and directories will be returned. Devices, FIFOs and sockets will be ignored.

const entries = await dir('foo/bar').entries()

files()

Asynchronous method to read the directory and return an array of any File objects.

const files = await dir('foo/bar').files()

directories()

Asynchronous method to read the directory and return an array of any Directory objects. The dirs() method is an alias for this method.

const dirs = await dir('foo/bar').directories()