update outputStream() method argument in README.md and FileX_methods.tgn

SayantanRC · Mar 13, 2021 · d91c9b1 · d91c9b1
1 parent c29d9bb
commit d91c9b1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -162,7 +162,7 @@ This creates a `FileXT` object i.e. with `isTraditional` = true even though the
 | renameTo(dest: FileX)                                                                                                        | Boolean                                     | -                                      | Move the current document to the path mentioned by the FileX parameter `dest`<br>For `FileX11` this only works for Android 7+ (API 24) due to Android limitations.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | renameTo(newFileName: String)                                                                                                | Boolean                                     | -                                      | Rename the document in place. This is used to only change the name and cannot move the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | inputStream()                                                                                                                | InputStream?                                | -                                      | Returns an `InputStream` to the document to write to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| outputStream()                                                                                                               | OutputStream?                               | -                                      | Returns an `OutputStream` to the document to read from.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| outputStream(mode:String="w")                                                                                                | OutputStream?                               | -                                      | Returns an `OutputStream` to the document to read from.<br><br>The `mode` argument is mainly useful for `FileX11`. It can be<br>`"r"` for read-only access,<br>`"w"` for write-only access (erasing whatever data is currently in the file),<br>`"wa"` for write-only access to append to any existing data,<br>`"rw"` for read and write access on any existing data,<br>and `"rwt"` for read and write access that truncates any existing file.<br><br>For `FileXT`, pass `"wa"` to get a `FileOutputStream` in append mode.                                                                                                                               |
 | list()                                                                                                                       | Array-String?                               | -                                      | Returns a String array of all the contents of a directory.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | list(filter: FileXFilter)                                                                                                    | Array-String?                               | -                                      | Returns the list filtering with a `FileXFilter`. This is similar to `FileFilter` in Java.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | list(filter: FileXNameFilter)                                                                                                | Array-String?                               | -                                      | Returns the list filtering with a `FileXNameFilter`. This is similar to `FilenameFilter` in Java.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |