Class DotGit

path

Static separator

isLink

• get isLink(): boolean

• Returns boolean

  true if this path is a symlink.

name

• get name(): string

• Returns string

  name of this file or directory.

parent

• get parent(): string

• Returns string

  absolute path to parent directory.

real

• get real(): this

• Returns this

shortPath

• get shortPath(): string

• Returns string

  a dotless relative path if this path is under the current working directory, otherwise returns an absolute path.

target

• get target(): null | this

• Returns null | this

url

• get url(): URL

• Returns URL

  this path represented as a file:/// URL

absLink

• absLink(path): DotGit

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

  Parameters

  • path: string | Path

  Returns DotGit

as

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

• Type Parameters

  • T

  • U extends BaseFile<T> | BaseDirectory<T, BaseFile<T>>

  Parameters

  • Ctor: PathCtor<U>

  Returns U

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

assert

• assert(): DotGit

• Returns DotGit

at

• at(...fragments): Path

• Parameters

  • Rest ...fragments: string[]

  Returns Path

  Path to directory relative to this.

delete

• delete(): DotGit

• Returns DotGit

entrypoint

• entrypoint<T>(command): undefined | T

• Type Parameters

  • T

  Parameters

  • command: ((argv) => T)

    • • (argv): T

      • Parameters

        • argv: string[]

        Returns T

  Returns undefined | T

exists

• exists(): null | Stats

• Returns null | Stats

in

• in(...fragments): Path

• Parameters

  • Rest ...fragments: string[]

  Returns Path

  Path to file relative to this.

isDirectory

• isDirectory(name?): boolean

• Parameters

  • Optional name: string

  Returns boolean

  true if a directory exists at this.path

isFile

• isFile(name?): boolean

• Parameters

  • Optional name: string

  Returns boolean

  true if a file exists at this.path

make

• make(): DotGit

• Returns DotGit

makeParent

• makeParent(): DotGit

• Create the parent directory of this path.

  Returns DotGit

pointTo

• pointTo(path): DotGit

• Turn this entry into a symlink to Path.

  Parameters

  • path: string

  Returns DotGit

relLink

• relLink(path): DotGit

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

  Parameters

  • path: string

  Returns DotGit

relative

• relative(path): string

• Parameters

  • path: string | Path

  Returns string

resolve

• resolve(path): string

• Parameters

  • path: string

  Returns string