Skip to content

Commit f1e4935

Browse files
committed
feat: auto update api docs
1 parent 2c3fbab commit f1e4935

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

docs/API-Reference/command/Commands.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,3 +1053,15 @@ Shows authors of current file
10531053
Toggles display of untracked files
10541054

10551055
**Kind**: global variable
1056+
<a name="CMD_GIT_HISTORY_GLOBAL"></a>
1057+
1058+
## CMD\_GIT\_HISTORY\_GLOBAL
1059+
Toggles global history view in history panel
1060+
1061+
**Kind**: global variable
1062+
<a name="CMD_GIT_HISTORY_FILE"></a>
1063+
1064+
## CMD\_GIT\_HISTORY\_FILE
1065+
Toggles file history view in history panel
1066+
1067+
**Kind**: global variable

docs/API-Reference/file/FileUtils.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ file size (in bytes)
2626
**Kind**: global constant
2727
<a name="readAsText"></a>
2828

29-
## readAsText(file, bypassCache) ⇒ <code>$.Promise</code>
29+
## readAsText(file, bypassCache, [options]) ⇒ <code>$.Promise</code>
3030
Asynchronously reads a file as UTF-8 encoded text.
3131

3232
**Kind**: global function
@@ -38,6 +38,9 @@ Asynchronously reads a file as UTF-8 encoded text.
3838
| --- | --- | --- |
3939
| file | <code>File</code> | File to read |
4040
| bypassCache | <code>boolean</code> | an optional argument, if specified will read from disc instead of using cache. |
41+
| [options] | <code>object</code> | |
42+
| [options.ignoreFileSizeLimits] | <code>boolean</code> | Will read larger files than 16MB limit. will bypassCache + won't cache if enabled. |
43+
| [options.doNotCache] | <code>boolean</code> | will not cache if enabled. Auto-enabled if ignoreFileSizeLimits = true |
4144

4245
<a name="writeText"></a>
4346

docs/API-Reference/filesystem/File.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ const File = brackets.getModule("filesystem/File")
1010

1111
* [File](#File)
1212
* [new File(fullPath, fileSystem)](#new_File_new)
13-
* [.read([options], callback)](#File+read)
13+
* [.read(options, callback)](#File+read)
1414
* [.write(data, [options], [callback])](#File+write)
1515

1616
<a name="new_File_new"></a>
1717

1818
### new File(fullPath, fileSystem)
19-
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.
2025

2126

2227
| Param | Type | Description |
@@ -26,14 +31,17 @@ Model for a File.This class should *not* be instantiated directly. Use FileSys
2631

2732
<a name="File+read"></a>
2833

29-
### file.read([options], callback)
34+
### file.read(options, callback)
3035
Read a file.
3136

3237
**Kind**: instance method of [<code>File</code>](#File)
3338

3439
| Param | Type | Description |
3540
| --- | --- | --- |
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 |
3745
| callback | <code>function</code> | Callback that is passed the FileSystemError string or the file's contents and its stats. |
3846

3947
<a name="File+write"></a>

0 commit comments

Comments
 (0)