Class Folder

Hierarchy

FileSystemEntity

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Folder(): Folder

Inherited from FileSystemEntity.constructor

Returns Folder

Properties

_extension

_extension: string

_isKnown

_isKnown: boolean

_lastModified

_lastModified: Date

_locked

_locked: boolean

_name

_name: string

_path

_path: string

Accessors

isKnown

get (): boolean

- Defined in file-system/index.ts:446
Returns boolean

lastModified

get (): Date

- Defined in file-system/index.ts:163
Returns Date

name

get (): string

- Defined in file-system/index.ts:155
Returns string

parent

get (): Folder

- Defined in file-system/index.ts:54
Returns Folder

path

get (): string

- Defined in file-system/index.ts:159
Returns string

Methods

clear

clear(): Promise<any>

- Defined in file-system/index.ts:427
Returns Promise<any>

clearSync

clearSync(onError?: function): void

- Defined in file-system/index.ts:442
Parameters
- Optional onError: function
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
Returns void

contains

contains(name: string): boolean

- Defined in file-system/index.ts:416
Parameters
- name: string
Returns boolean

eachEntity

eachEntity(onEntity: function): void

- Defined in file-system/index.ts:515
Parameters
- onEntity: function
  - - (entity: FileSystemEntity): boolean
    - Parameters
      - entity: FileSystemEntity
      Returns boolean
Returns void

getEntities

getEntities(): Promise<FileSystemEntity[]>

- Defined in file-system/index.ts:482
Returns Promise<FileSystemEntity[]>

getEntitiesSync

getEntitiesSync(onError?: function): FileSystemEntity[]

- Defined in file-system/index.ts:497
Parameters
- Optional onError: function
  - - (error: any): any
    - Parameters
      - error: any
      Returns any
Returns FileSystemEntity[]

getFile

getFile(name: string): File

- Defined in file-system/index.ts:450
Parameters
- name: string
Returns File

getFolder

getFolder(name: string): Folder

- Defined in file-system/index.ts:466
Parameters
- name: string
Returns Folder

remove

remove(): Promise<any>

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

removeSync

removeSync(onError?: function): void

Inherited from FileSystemEntity.removeSync
- Defined in file-system/index.ts:82
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/index.ts:100
Parameters
- newName: string
Returns Promise<any>

renameSync

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

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

Static exists

exists(path: string): boolean

- Defined in file-system/index.ts:412
Parameters
- path: string
Returns boolean

Static fromPath

fromPath(path: string): Folder

- Defined in file-system/index.ts:399
Parameters
- path: string
Returns Folder

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