Preview 2.0 is now in Public Beta!
Read the Announcement

Summary

Constructors

constructor

new File(): File
inherited from constructor
Returns File

Properties

extension

isLocked

Methods

read

read(): Promise<any>
Returns Promise<any>

readSync

readSync(onError?: (error: any) => any): any
Parameter Default Description
onError
(error: any) => any

Returns any

readText

readText(encoding?: string): Promise<string>
Parameter Default Description
encoding
string

Returns Promise<string>

readTextSync

readTextSync(onError?: (error: any) => any, encoding?: string): string
Parameter Default Description
onError
(error: any) => any

encoding
string

Returns string

write

write(content: any): Promise<void>
Parameter Default Description
content
any

Returns Promise<void>

writeSync

writeSync(content: any, onError?: (error: any) => any): void
Parameter Default Description
content
any

onError
(error: any) => any

Returns void

writeText

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

encoding
string

Returns Promise<any>

writeTextSync

writeTextSync(
  content: string,
  onError?: (error: any) => any,
  encoding?: string
): void
Parameter Default Description
content
string

onError
(error: any) => any

encoding
string

Returns void

exists

Static
exists(path: string): boolean
Parameter Default Description
path
string

Returns boolean

fromPath

Static
fromPath(path: string): File
Parameter Default Description
path
string

Returns File