NativeScript/file-system/file-system.d.ts

import promises = require("promises/promises");

export declare class FileSystemEntity {
    /**
      * Gets the Date object specifying the last time this entity was modified.
      */
    public lastModified: Date;

    /**
      * Gets the name of the entity.
      */
    public name: string;

    /**
      * Gets the fully-qualified path (including the extension for a File) of the entity.
      */
    public path: string;

    /**
    * 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.
    */
    public parent: Folder;

    /**
      * Removes (deletes) the current Entity from the file system.
      */
    public remove(): promises.Promise<any>;

    /**
    * Renames the current entity using the specified name.
    */
    public rename(newName: string): promises.Promise<any>;
}

export declare class File extends FileSystemEntity {
    /**
      * Checks whether a File with the specified path already exists.
      */
    public static exists(path: string): boolean;

    /**
      * Gets the extension of the file.
      */
    public extension: string;

    /**
      * Gets a value indicating whether the file is currently locked, meaning a background operation associated with this file is running.
      */
    public isLocked: boolean;

    /**
      * Gets or creates a File entity at the specified path.
      */
    public static fromPath(path: string): File;
    
    /**
      * Reads the content of the file as a string using the specified encoding (defaults to UTF-8).
      */
    public readText(encoding?: string): promises.Promise<string>;

    /**
      * Writes the provided string to the file, using the specified encoding (defaults to UTF-8).
      */
    public writeText(content: string, encoding?: string): promises.Promise<any>;
}

export declare class Folder extends FileSystemEntity {
    /**
      * Determines whether this instance is a KnownFolder (accessed through the KnownFolders object).
      */
    public isKnown: boolean;

    /**
      * Gets or creates a Folder entity at the specified path.
      */
    public static fromPath(path: string): Folder;

    /**
      * Checks whether a Folder with the specified path already exists.
      */
    public static exists(path: string): boolean;

    /**
    Checks whether this Folder contains an Entity with the specified name.
    The path of the folder is added to the name to resolve the complete path to check for.
      */
    public contains(name: string): boolean;

    /**
      * Deletes all the files and folders (recursively), contained within this Folder.
      */
    public clear(): promises.Promise<any>;

    /**
      * Gets or creates a File entity with the specified name within this Folder.
      */
    public getFile(name: string): File;

    /**
    * Gets or creates a Folder entity with the specified name within this Folder.
    */
    public getFolder(name: string): Folder;

    /**
    * Gets all the top-level entities residing within this folder.
    */
    public getEntities(): promises.Promise<Array<FileSystemEntity>>;

    /**
    Enumerates all the top-level FileSystem entities residing within this folder.
    The first parameter is a callback that receives the current entity.
    If the callback returns false this will mean for the iteration to stop.
    */
    public eachEntity(onEntity: (entity: FileSystemEntity) => boolean);
}

/**
  * Provides access to the top-level Folders instances that are accessible from the application. Use these as entry points to access the FileSystem.
  */
export declare module knownFolders {
    /**
    * Gets the Documents folder available for the current application. This Folder is private for the application and not accessible from Users/External apps.
    */
    export function documents(): Folder;

    /**
    * Gets the Temporary (Caches) folder available for the current application. This Folder is private for the application and not accessible from Users/External apps.
    */
    export function temp(): Folder;
}

/**
* Enables path-specific operations like join, extension, etc.
*/
export declare module path {
    /**
    * Normalizes a path, taking care of occurrances like ".." and "//"
    */
    export function normalize(path: string): string;

    /**
    * Joins all the provided string components, forming a valid and normalized path.
    */
    export function join(...paths: string[]): string;

    /**
    * Gets the string used to separate file paths.
    */
    export var separator: string;
}