typescript-closure-tools/index/closure-library/closure/goog/fs/filereader.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />
/// <reference path="../events/eventtarget.d.ts" />
/// <reference path="./error.d.ts" />
/// <reference path="../../../third_party/closure/goog/mochikit/async/deferred.d.ts" />

declare module goog.fs {

    class FileReader extends FileReader__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class FileReader__Class extends goog.events.EventTarget__Class  { 
    
            /**
             * An object for monitoring the reading of files. This emits ProgressEvents of
             * the types listed in {@link goog.fs.FileReader.EventType}.
             *
             * @constructor
             * @extends {goog.events.EventTarget}
             * @final
             */
            constructor();
    
            /**
             * Abort the reading of the file.
             */
            abort(): void;
    
            /**
             * @return {goog.fs.FileReader.ReadyState} The current state of the FileReader.
             */
            getReadyState(): goog.fs.FileReader.ReadyState;
    
            /**
             * @return {*} The result of the file read.
             */
            getResult(): any;
    
            /**
             * @return {goog.fs.Error} The error encountered while reading, if any.
             */
            getError(): goog.fs.Error;
    
            /**
             * Starts reading a blob as a binary string.
             * @param {!Blob} blob The blob to read.
             */
            readAsBinaryString(blob: Blob): void;
    
            /**
             * Starts reading a blob as an array buffer.
             * @param {!Blob} blob The blob to read.
             */
            readAsArrayBuffer(blob: Blob): void;
    
            /**
             * Starts reading a blob as text.
             * @param {!Blob} blob The blob to read.
             * @param {string=} opt_encoding The name of the encoding to use.
             */
            readAsText(blob: Blob, opt_encoding?: string): void;
    
            /**
             * Starts reading a blob as a data URL.
             * @param {!Blob} blob The blob to read.
             */
            readAsDataUrl(blob: Blob): void;
    } 
    
}

declare module goog.fs.FileReader {

    /**
     * Possible states for a FileReader.
     *
     * @enum {number}
     */
    enum ReadyState { INIT, LOADING, DONE } 

    /**
     * Events emitted by a FileReader.
     *
     * @enum {string}
     */
    enum EventType { LOAD_START, PROGRESS, LOAD, ABORT, ERROR, LOAD_END } 

    /**
     * Reads a blob as a binary string.
     * @param {!Blob} blob The blob to read.
     * @return {!goog.async.Deferred} The deferred Blob contents as a binary string.
     *     If an error occurs, the errback is called with a {@link goog.fs.Error}.
     */
    function readAsBinaryString(blob: Blob): goog.async.Deferred<any>;

    /**
     * Reads a blob as an array buffer.
     * @param {!Blob} blob The blob to read.
     * @return {!goog.async.Deferred} The deferred Blob contents as an array buffer.
     *     If an error occurs, the errback is called with a {@link goog.fs.Error}.
     */
    function readAsArrayBuffer(blob: Blob): goog.async.Deferred<any>;

    /**
     * Reads a blob as text.
     * @param {!Blob} blob The blob to read.
     * @param {string=} opt_encoding The name of the encoding to use.
     * @return {!goog.async.Deferred} The deferred Blob contents as text.
     *     If an error occurs, the errback is called with a {@link goog.fs.Error}.
     */
    function readAsText(blob: Blob, opt_encoding?: string): goog.async.Deferred<any>;

    /**
     * Reads a blob as a data URL.
     * @param {!Blob} blob The blob to read.
     * @return {!goog.async.Deferred} The deferred Blob contents as a data URL.
     *     If an error occurs, the errback is called with a {@link goog.fs.Error}.
     */
    function readAsDataUrl(blob: Blob): goog.async.Deferred<any>;
}