Options
All
  • Public
  • Public/Protected
  • All
Menu

Class File

Hierarchy

Index

Properties

extension

extension: string

isLocked

isLocked: boolean

lastModified

lastModified: Date

name

name: string

parent

parent: Folder

path

path: string

size

size: number

Methods

read

  • read(): Promise<any>

readSync

  • readSync(onError?: function): any

readText

  • readText(encoding?: string): Promise<string>

readTextSync

  • readTextSync(onError?: function, encoding?: string): string
  • Parameters

    • Optional onError: function
        • (error: any): any
        • Parameters

          • error: any

          Returns any

    • Optional encoding: string

    Returns string

remove

  • remove(): Promise<any>

removeSync

  • removeSync(onError?: function): void

rename

  • rename(newName: string): Promise<any>

renameSync

  • renameSync(newName: string, onError?: function): void

write

  • write(content: any): Promise<void>

writeSync

  • writeSync(content: any, onError?: function): void
  • Parameters

    • content: any
    • Optional onError: function
        • (error: any): any
        • Parameters

          • error: any

          Returns any

    Returns void

writeText

  • writeText(content: string, encoding?: string): Promise<any>

writeTextSync

  • writeTextSync(content: string, onError?: function, encoding?: string): void
  • Parameters

    • content: string
    • Optional onError: function
        • (error: any): any
        • Parameters

          • error: any

          Returns any

    • Optional encoding: string

    Returns void

Static exists

  • exists(path: string): boolean

Static fromPath

  • fromPath(path: string): File

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method