You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Model for a File.This class should *not* be instantiated directly. Use FileSystem.getFileForPath,FileSystem.resolve, or Directory.getContents to create an instance of this class.See the FileSystem class for more details.
19
+
Model for a File.
20
+
21
+
This class should *not* be instantiated directly. Use FileSystem.getFileForPath,
22
+
FileSystem.resolve, or Directory.getContents to create an instance of this class.
23
+
24
+
See the FileSystem class for more details.
20
25
21
26
22
27
| Param | Type | Description |
@@ -26,14 +31,17 @@ Model for a File.This class should *not* be instantiated directly. Use FileSys
26
31
27
32
<aname="File+read"></a>
28
33
29
-
### file.read([options], callback)
34
+
### file.read(options, callback)
30
35
Read a file.
31
36
32
37
**Kind**: instance method of [<code>File</code>](#File)
33
38
34
39
| Param | Type | Description |
35
40
| --- | --- | --- |
36
-
|[options]| <code>Object</code> | properties \{encoding: 'one of format supported here: https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/encoding'}|
41
+
| options | <code>Object</code> ||
42
+
|[options.encoding]| <code>string</code> | 'one of format supported here: https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/encoding'|
43
+
|[options.ignoreFileSizeLimits]| <code>boolean</code> | by default max file size that can be read is 16MB. |
44
+
|[options.doNotCache]| <code>boolean</code> | will not cache if enabled. Auto-enabled if ignoreFileSizeLimits = true |
37
45
| callback | <code>function</code> | Callback that is passed the FileSystemError string or the file's contents and its stats. |
0 commit comments