FileSystemEntity

Defined in: file-system/index.d.ts:27

Represents a single entity on the file system.

Extended by ​

• File
• Folder

Constructors ​

Constructor ​

new FileSystemEntity(): FileSystemEntity;

Returns ​

FileSystemEntity

Properties ​

lastModified ​

lastModified: Date;

Defined in: file-system/index.d.ts:31

Gets the Date object specifying the last time this entity was modified.

name ​

name: string;

Defined in: file-system/index.d.ts:36

Gets the name of the entity.

parent ​

parent: Folder;

Defined in: file-system/index.d.ts:48

Gets the Folder object representing the parent of this entity. Will be null for a root folder like Documents or Temporary. This property is readonly.

path ​

path: string;

Defined in: file-system/index.d.ts:41

Gets the fully-qualified path (including the extension for a File) of the entity.

Methods ​

remove() ​

remove(): Promise<any>;

Defined in: file-system/index.d.ts:53

Removes (deletes) the current Entity from the file system.

Returns ​

Promise<any>

removeSync() ​

removeSync(onError?: (error: any) => any): void;

Defined in: file-system/index.d.ts:58

Removes (deletes) the current Entity from the file system synchronously.

Parameters ​

Returns ​

void

rename() ​

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

Defined in: file-system/index.d.ts:64

Renames the current entity using the specified name.

Parameters ​

Returns ​

Promise<any>

renameSync() ​

renameSync(newName: string, onError?: (error: any) => any): void;

Defined in: file-system/index.d.ts:70

Renames the current entity synchronously, using the specified name.

Parameters ​

Returns ​

void