[CB-1179] File error docs are inconsistent

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Duplicate
• Affects Version/s: 2.0.0
• Fix Version/s: 2.1.0

Environment

File API docs.phonegap.com

• Assignee: Jesse MacFadyen
• Reporter: Jesse MacFadyen
• Created: 02/Aug/12 01:54
• Updated: 23/Aug/18 06:43
• Resolved: 14/Aug/12 23:37

Description

The result of File API calls are not clearly defined:

Some document examples expect the error handler to receive a full fledged object with a target of a FileError object.

ex.

function fail(evt) {
        console.log(evt.target.error.code);
    }

The mobile spec tests specifically test that the returned object is a FileError object :

ex.

expect(error).toBeFileError(FileError.NOT_FOUND_ERR);

 toBeFileError: function(code) {
                var error = this.actual;
                this.message = function(){
                    return "Expected FileError with code " + fileErrorMap[error.code] + " (" + error.code + ") to be " + fileErrorMap[code] + "(" + code + ")";
                };
                return (error.code == code);
            }