Class File

Hierarchy (view full)

Constructors

constructor

Properties

absolute format log separator

Accessors

[toStringTag] dirname isLink name parent real relativePath short shortPath target url

Methods

absLink as assert basename delete edit entrypoint exists isDirectory isFile load loadBinary loadRaw make makeParent pointTo relLink relativeFrom relativeTo resolve save saveBinary saveRaw setFormat sha256

Constructors

constructor

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

  • Parameters

    • base: ToPath = ...
    • Rest ...fragments: string[]

    Returns File

Properties

absolute

absolute: string

The resolved absolute filesystem path represented by this object.

format

format: {
    load<T>(data): T;
    save(data): any;
} = Text

Type declaration

  • load:function
    • load<T>(data): T

    • Type Parameters

      • T

      Parameters

      • data: unknown

      Returns T

  • save:function
    • save(data): any

    • Parameters

      • data: unknown

      Returns any

log

log: Core.Console

Static separator

separator: "\\" | "/" = sep

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

dirname

  • get dirname(): string

  • Returns string

    absolute path to parent directory.

isLink

  • 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

Methods

absLink

  • absLink(path): this

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

    Parameters

    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

edit

  • edit<T>(fn): this

  • Type Parameters

    • T

    Parameters

    • fn: ((data) => T)
        • (data): T

        • Parameters

          • data: T

          Returns T

    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

load

  • load<T>(): T

  • Type Parameters

    • T

    Returns T

loadBinary

  • loadBinary(): Uint8Array

  • Returns Uint8Array

loadRaw

  • loadRaw(encoding?): string

  • Parameters

    • encoding: BufferEncoding = 'utf8'

    Returns string

make

  • make(): File

  • Returns File

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

resolve

  • resolve(path): string

  • Parameters

    • path: string

    Returns string

save

  • save(data): this

  • Parameters

    • data: any

    Returns this

saveBinary

  • saveBinary(data): this

  • Parameters

    • data: Uint8Array

    Returns this

saveRaw

  • saveRaw(data, encoding?): File

  • Parameters

    • data: string
    • encoding: BufferEncoding = 'utf8'

    Returns File

setFormat

  • setFormat(format): File

  • Parameters

    • format: {
          load<T>(data): T;
          save(data): any;
      }
      • load:function
        • load<T>(data): T

        • Type Parameters

          • T

          Parameters

          • data: unknown

          Returns T

      • save:function
        • save(data): any

        • Parameters

          • data: unknown

          Returns any

    Returns File

sha256

  • sha256(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc