LockedFile.readAsText()

by 3 contributors:

This article is in need of a technical review.

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Summary

The readAsText method is used to read the content of the LockedFile object and provide the result of that reading as a string. In many ways, it performs like the FileReader.readAsText() method.

The reading operation starts at the position given by the LockedFile.location property.

Syntax

var request = instanceOfLockedFile.readAsText(size[, encoding]);

Parameters

size
A number representing the number of bytes to read in the file.
encoding Optional
A string indicating the encoding to use for the returned data. By default, UTF-8 is assumed if this parameter is not specified.

Return

A FileRequest object to handle the success or failure of the operation. In case of success, the request's result is a string representing the data that have been read.

Specifications

Specification Status Comment
FileSystem API Editor's Draft Draft proposal

See also

Document Tags and Contributors

Contributors to this page: fscholz, kscarfone, Jeremie
Last updated by: fscholz,