Methods
deleteFile
- deleteFile(path: string, onError?: function): any
-
Parameters
-
path: string
-
Optional onError: function
Returns any
deleteFolder
- deleteFolder(path: string, onError?: function): any
-
Parameters
-
path: string
-
Optional onError: function
Returns any
eachEntity
- eachEntity(path: string, onEntity: function, onError?: function): any
-
Parameters
-
path: string
-
onEntity: function
-
- (entity: object): boolean
-
Parameters
-
entity: object
-
extension: string
-
name: string
-
path: string
Returns boolean
-
Optional onError: function
Returns any
emptyFolder
- emptyFolder(path: string, onError?: function): void
-
Parameters
-
path: string
-
Optional onError: function
Returns void
fileExists
- fileExists(path: string): boolean
-
Parameters
Returns boolean
folderExists
- folderExists(path: string): boolean
-
Parameters
Returns boolean
getCurrentAppPath
- getCurrentAppPath(): string
-
Returns string
getDocumentsFolderPath
- getDocumentsFolderPath(): string
-
Returns string
getEntities
- getEntities(path: string, onError?: function): Array<object>
-
Parameters
-
path: string
-
Optional onError: function
Returns Array<object>
getFile
- getFile(path: string, onError?: function): object
-
Parameters
-
path: string
-
Optional onError: function
Returns object
-
extension: string
-
name: string
-
path: string
getFileExtension
- getFileExtension(path: string): string
-
Parameters
Returns string
getFileSize
- getFileSize(path: string): number
-
Parameters
Returns number
getFolder
- getFolder(path: string, onError?: function): object
-
Parameters
-
path: string
-
Optional onError: function
Returns object
-
name: string
-
path: string
getLastModified
- getLastModified(path: string): Date
-
Parameters
Returns Date
getLogicalRootPath
- getLogicalRootPath(): string
-
Returns string
getParent
- getParent(path: string, onError?: function): object
-
Parameters
-
path: string
-
Optional onError: function
Returns object
-
name: string
-
path: string
getPathSeparator
- getPathSeparator(): string
-
Returns string
getTempFolderPath
- getTempFolderPath(): string
-
Returns string
joinPath
- joinPath(left: string, right: string): string
-
Parameters
-
left: string
-
right: string
Returns string
joinPaths
- joinPaths(paths: string[]): string
-
Parameters
Returns string
normalizePath
- normalizePath(path: string): string
-
Parameters
Returns string
read
- read(path: string, onError?: function): any
-
Parameters
-
path: string
-
Optional onError: function
Returns any
readAsync
- readAsync(path: string): Promise<any>
-
Parameters
Returns Promise<any>
readSync
- readSync(path: string, onError?: function): any
-
Parameters
-
path: string
-
Optional onError: function
Returns any
readText
- readText(path: string, onError?: function, encoding?: any): string
-
Parameters
-
path: string
-
Optional onError: function
-
Optional encoding: any
Returns string
readTextAsync
- readTextAsync(path: string, encoding?: any): Promise<string>
-
Parameters
-
path: string
-
Optional encoding: any
Returns Promise<string>
readTextSync
- readTextSync(path: string, onError?: function, encoding?: any): string
-
Parameters
-
path: string
-
Optional onError: function
-
Optional encoding: any
Returns string
rename
- rename(path: string, newPath: string, onError?: function): void
-
Parameters
-
path: string
-
newPath: string
-
Optional onError: function
Returns void
write
- write(path: string, content: any, onError?: function): any
-
Parameters
-
path: string
-
content: any
-
Optional onError: function
Returns any
writeAsync
- writeAsync(path: string, content: any): Promise<void>
-
Parameters
-
path: string
-
content: any
Returns Promise<void>
writeSync
- writeSync(path: string, content: any, onError?: function): any
-
Parameters
-
path: string
-
content: any
-
Optional onError: function
Returns any
writeText
- writeText(path: string, content: string, onError?: function, encoding?: any): any
-
Parameters
-
path: string
-
content: string
-
Optional onError: function
-
Optional encoding: any
Returns any
writeTextAsync
- writeTextAsync(path: string, content: string, encoding?: any): Promise<void>
-
Parameters
-
path: string
-
content: string
-
Optional encoding: any
Returns Promise<void>
writeTextSync
- writeTextSync(path: string, content: string, onError?: function, encoding?: any): any
-
Parameters
-
path: string
-
content: string
-
Optional onError: function
-
Optional encoding: any
Returns any
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