TypeScript documentation - type-params, lambdas and object-type.

PanayotCankov · PanayotCankov · commit 36c1910cb2a1 · 2014-06-02T16:49:28.000+03:00
diff --git a/Tests/file-system-tests.ts b/Tests/file-system-tests.ts
@@ -2,7 +2,6 @@
 // <snippet name="file-system">
 // # File System
 // Using the file system requires the FileSystem module.
-// TODO: var fs = require("file-system"); => this will break the intellisense of the tests
 // ``` JavaScript
 import fs = require("file-system");
 // ```
diff --git a/file-system/file-system.d.ts b/file-system/file-system.d.ts
@@ -6,39 +6,39 @@ declare module "file-system" {
     /**
     * Represents a single entity on the file system.
     */
-    export class FileSystemEntity {
+    class FileSystemEntity {
         /**
           * Gets the Date object specifying the last time this entity was modified.
           */
-        public lastModified: Date;
+        lastModified: Date;
 
         /**
           * Gets the name of the entity.
           */
-        public name: string;
+        name: string;
 
         /**
           * Gets the fully-qualified path (including the extension for a File) of the entity.
           */
-        public path: string;
+        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;
+        parent: Folder;
 
         /**
           * Removes (deletes) the current Entity from the file system.
           */
-        public remove(): promises.Promise<any>;
+        remove(): promises.Promise<any>;
 
         /**
         * Renames the current entity using the specified name.
         * @param newName The new name to be applied to the entity.
         */
-        public rename(newName: string): promises.Promise<any>;
+        rename(newName: string): promises.Promise<any>;
     }
 
     /**
@@ -49,36 +49,36 @@ declare module "file-system" {
         * Checks whether a File with the specified path already exists.
         * @param path The path to check for.
         */
-        public static exists(path: string): boolean;
+        static exists(path: string): boolean;
 
         /**
         * Gets the extension of the file.
         */
-        public extension: string;
+        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;
+        isLocked: boolean;
 
         /**
         * Gets or creates a File entity at the specified path.
         * @param path The path to get/create the file at.
         */
-        public static fromPath(path: string): File;
+        static fromPath(path: string): File;
 
         /**
         * Reads the content of the file as a string using the specified encoding (defaults to UTF-8).
         * @param encoding An optional value specifying the preferred encoding (defaults to UTF-8).
         */
-        public readText(encoding?: string): promises.Promise<string>;
+        readText(encoding?: string): promises.Promise<string>;
 
         /**
         * Writes the provided string to the file, using the specified encoding (defaults to UTF-8).
         * @param content The content to be saved to the file.
         * @param encoding An optional value specifying the preferred encoding (defaults to UTF-8).
         */
-        public writeText(content: string, encoding?: string): promises.Promise<any>;
+        writeText(content: string, encoding?: string): promises.Promise<any>;
     }
 
     /**
@@ -88,90 +88,90 @@ declare module "file-system" {
         /**
         * Determines whether this instance is a KnownFolder (accessed through the KnownFolders object).
         */
-        public isKnown: boolean;
+        isKnown: boolean;
 
         /**
         * Gets or creates a Folder entity at the specified path.
         * @param path The path to get/create the folder at.
         */
-        public static fromPath(path: string): Folder;
+        static fromPath(path: string): Folder;
 
         /**
         * Checks whether a Folder with the specified path already exists.
         * @param path The path to check for.
         */
-        public static exists(path: string): boolean;
+        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.
         * @param name The name of the entity to check for.
         */
-        public contains(name: string): boolean;
+        contains(name: string): boolean;
 
         /**
           * Deletes all the files and folders (recursively), contained within this Folder.
           */
-        public clear(): promises.Promise<any>;
+        clear(): promises.Promise<any>;
 
         /**
         * Gets or creates a File entity with the specified name within this Folder.
         * @param name The name of the file to get/create.
         */
-        public getFile(name: string): File;
+        getFile(name: string): File;
 
         /**
         * Gets or creates a Folder entity with the specified name within this Folder.
         * @param name The name of the folder to get/create.
         */
-        public getFolder(name: string): Folder;
+        getFolder(name: string): Folder;
 
         /**
         * Gets all the top-level entities residing within this folder.
         */
-        public getEntities(): promises.Promise<Array<FileSystemEntity>>;
+        getEntities(): promises.Promise<Array<FileSystemEntity>>;
 
         /**
         * Enumerates all the top-level FileSystem entities residing within this folder.
         * @param onEntity 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);
+        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 module knownFolders {
+    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;
+        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;
+        function temp(): Folder;
     }
 
     /**
     * Enables path-specific operations like join, extension, etc.
     */
-    export module path {
+    module path {
         /**
         * Normalizes a path, taking care of occurrances like ".." and "//".
         * @param path The path to be normalized.
         */
-        export function normalize(path: string): string;
+        function normalize(path: string): string;
 
         /**
         * Joins all the provided string components, forming a valid and normalized path.
         * @param paths An array of string components to be joined.
         */
-        export function join(...paths: string[]): string;
+        function join(...paths: string[]): string;
 
         /**
         * Gets the string used to separate file paths.
         */
-        export var separator: string;
+        var separator: string;
     }
 }
