Class File

constructor

• new File(path: string): File

  Parameters

  • path: string

  Returns File

• new File(resolvable: FileResolvable): File

  Parameters

  • resolvable: FileResolvable

  Returns File

Readonlypath

exists

• get exists(): boolean

  Returns boolean

lastModified

• get lastModified(): number

  Returns number

name

• get name(): string

  Returns string

realpath

• get realpath(): string

  Returns string

size

• get size(): number

  Returns number

stat

• get stat(): Stats

  Returns Stats

state

• get state(): FileState

  Returns FileState

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>

[dispose]

• "[dispose]"(): void

  Returns void

checkExists

• checkExists(): Promise<File>

  Returns Promise<File>

checkRealpath

• checkRealpath(): Promise<File>

  Returns Promise<File>

clearCache

• clearCache(): this

  Returns this

createReadStream

• createReadStream(options?: CreateReadStreamOptions): ReadStream

  Parameters

  • Optionaloptions: CreateReadStreamOptions

  Returns ReadStream

delete

• delete(): Promise<void>

  Returns Promise<void>

deleteRecursive

• deleteRecursive(): Promise<void>

  Returns Promise<void>

passive

• passive(stat?: boolean): Promise<File>

  Parameters

  • stat: boolean = false

  Returns Promise<File>

preCompute

• preCompute(): Promise<File>

  Returns Promise<File>

readContents

• readContents(buffer?: false): Promise<string>

  Parameters

  • Optionalbuffer: false

  Returns Promise<string>

• readContents(buffer: true): Promise<Buffer<ArrayBufferLike>>

  Parameters

  • buffer: true

  Returns Promise<Buffer<ArrayBufferLike>>

readJson

• readJson<T>(): Promise<T>

  Type Parameters

  • T

  Returns Promise<T>

readLines

• readLines(): Promise<
      Iterable<string, any, any>
      | AsyncIterable<string, any, any>,
  >

  Returns Promise<Iterable<string, any, any> | AsyncIterable<string, any, any>>

runStat

• runStat(): Promise<File>

  Returns Promise<File>

writeContents

• writeContents(contents: string): Promise<void>

  Parameters

  • contents: string

  Returns Promise<void>

writeJson

• writeJson(contents: object): Promise<void>

  Parameters

  • contents: object

  Returns Promise<void>

Staticof

• of(resolvable: FileResolvable): File

  Parameters

  • resolvable: FileResolvable

  Returns File

Staticopen

• open(resolvable: FileResolvable, stat?: boolean): Promise<File>

  Parameters

  • resolvable: FileResolvable
  • stat: boolean = false

  Returns Promise<File>