Class File

Hierarchy

FileSystemEntity

Index

Properties

Methods

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>

- Defined in file-system/file-system.d.ts:102
Returns Promise<any>

readSync

readSync(onError?: function): any

- Defined in file-system/file-system.d.ts:108
Parameters
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
Returns any

readText

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

- Defined in file-system/file-system.d.ts:90
Parameters
- Optional encoding: string
Returns Promise<string>

readTextSync

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

- Defined in file-system/file-system.d.ts:97
Parameters
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
- Optional encoding: string
Returns string

remove

remove(): Promise<any>

Inherited from FileSystemEntity.remove
- Defined in file-system/file-system.d.ts:35
Returns Promise<any>

removeSync

removeSync(onError?: function): void

Inherited from FileSystemEntity.removeSync
- Defined in file-system/file-system.d.ts:40
Parameters
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
Returns void

rename

rename(newName: string): Promise<any>

Inherited from FileSystemEntity.rename
- Defined in file-system/file-system.d.ts:46
Parameters
- newName: string
Returns Promise<any>

renameSync

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

Inherited from FileSystemEntity.renameSync
- Defined in file-system/file-system.d.ts:52
Parameters
- newName: string
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
Returns void

write

write(content: any): Promise<void>

- Defined in file-system/file-system.d.ts:129
Parameters
- content: any
Returns Promise<void>

writeSync

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

- Defined in file-system/file-system.d.ts:136
Parameters
- content: any
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
Returns void

writeText

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

- Defined in file-system/file-system.d.ts:115
Parameters
- content: string
- Optional encoding: string
Returns Promise<any>

writeTextSync

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

- Defined in file-system/file-system.d.ts:123
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

- Defined in file-system/file-system.d.ts:63
Parameters
- path: string
Returns boolean

Static fromPath

fromPath(path: string): File

- Defined in file-system/file-system.d.ts:84
Parameters
- path: string
Returns 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