Class Directory

constructor

• new Directory(base?, ...fragments): Directory

• Parameters

  • base: ToPath = ...

  • Rest ...fragments: string[]

  Returns Directory

absolute

log

Static separator

[toStringTag]

• get [toStringTag](): string

• Returns string

dirname

• get dirname(): string

• Returns string

  absolute path to parent directory.

isLink

• get isLink(): boolean

• Returns boolean

  true if this.absolute is a symlink.

name

• get name(): string

• Returns string

  name of this file or directory.

parent

• get parent(): Directory

• Returns Directory

  absolute path to parent directory.

real

• get real(): this

• Returns this

relativePath

• get relativePath(): string

• Returns string

short

• get short(): string

• Returns string

shortPath

• get shortPath(): string

• Returns string

target

• get target(): this

• Returns this

url

• get url(): URL

• Returns URL

  this.absolute represented as a file:/// URL

absLink

• absLink(path): this

• Turn this entry into a symlink to an absolute path.

  Parameters

  • path: string | Path

  Returns this

as

• as<T, U>(Ctor): T

• Type Parameters

  • T

  • U extends (new (path) => T)

  Parameters

  • Ctor: U

  Returns T

  an instance of the passed class, pointing to this.absolute, and (hopefully) knowing what to do with the data at this.absolute.

assert

• assert(): this

• Returns this

basename

• basename(ext?): string

• Parameters

  • Optional ext: string

  Returns string

  name of this file or directory.

delete

• delete(): this

• Returns this

entrypoint

• entrypoint<T>(command): T

• Type Parameters

  • T

  Parameters

  • command: ((argv) => T)

    • • (argv): T

      • Parameters

        • argv: string[]

        Returns T

  Returns T

exists

• exists(): Stats

• Returns Stats

isDirectory

• isDirectory(name?): boolean

• Parameters

  • Optional name: string

  Returns boolean

  true if a directory exists at this.absolute

isFile

• isFile(name?): boolean

• Parameters

  • Optional name: string

  Returns boolean

  true if a file exists at this.absolute

makeParent

• makeParent(): this

• Create the parent directory of this.absolute.

  Returns this

pointTo

• pointTo(path): this

• Turn this entry into a symlink to Path.

  Parameters

  • path: string

  Returns this

relLink

• relLink(path): this

• Turn this entry into a symlink to a relative path.

  Parameters

  • path: string

  Returns this

relativeFrom

• relativeFrom(base?): string

• Parameters

  • base: string = ...

  Returns string

relativeTo

• relativeTo(target?): string

• Parameters

  • target: string = ...

  Returns string