Class DirectoryEntry

A directory entry.

Hierarchy

Implements

  • DirectoryEntryData

Constructors

Properties

files: {
    [filename: string]: EntryData | undefined;
}

Type declaration

  • [filename: string]: EntryData | undefined

Methods

  • Gets the entry at the given path.

    Parameters

    • path: string | string[]

      The path or path chunks to get the entry at.

    Returns Entry

  • Lists all files in this directory. This is not recursive.

    Returns string[]

    A list of all files in this directory.

  • Walks through the directory and recursively yields all files and directories.

    Parameters

    • includeDirectories: boolean = true

      Whether to include directories in the result.

    • _path: null | string[] = null

      Used internally for recursion.

    Returns Generator<readonly [string, string[], Entry], void, unknown>

  • Checks wether the given value is an entry.

    Parameters

    • entry: unknown

      The value to check.

    Returns entry is Entry

Generated using TypeDoc