Object “fs”
Object > NativeObject > FileSystem
The fs object provides methods to read and write files. All methods are asynchronous and return a promise.
| Constructor | private |
| Singleton | fs |
| Namespace | tabris |
| Direct subclasses | None |
| JSX support | No |
Example
import {fs} from 'tabris';
fs.writeFile(fs.cacheDir + '/file.txt', "Hello World!")
.then(() => console.log(`File written successfully`))
.catch(error => console.error(error));
See also:
JSX Using the file system to read and write files
Methods
readDir(path)
Reads the contents of a given directory. Returns a promise that resolves on success to an array of the names of the files in the directory excluding ‘.’ and ‘..’. In case of failure, the Promise rejects with an Error.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the directory to read. |
Returns Promise<string[]>
readFile(path)
Reads the given file and returns a promise that resolves to the contents of the file on success and rejects with an Error in case of a failure. The file contents are returned as an ArrayBuffer.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the file to read. |
Returns Promise<ArrayBuffer>
readFile(path, encoding)
Reads the given text file and returns a promise that resolves to the contents of the file on success and rejects with an Error in case of a failure. The file contents are returned as a string.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the file to read. |
| encoding | string |
No | The encoding to use to read text files. |
Returns Promise<string>
removeFile(path)
Removes the given file. Returns a promise that resolves on success and rejects with an Error in case of a failure.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the file to remove. |
Returns Promise<void>
writeFile(path, data)
Writes the given binary contents to the given file. If the file exists, it is overwritten, otherwise it is created. Returns a promise that resolves on success and rejects with an Error in case of a failure.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the file to write. |
| data | ArrayBuffer | Blob |
No | The contents to write to the file. |
Returns Promise<void>
writeFile(path, text, encoding?)
Writes the given text to the given file using the given encoding or utf-8 if no encoding is specified. If the file exists, it is overwritten, otherwise it is created. Returns a promise that resolves on success and rejects with an Error in case of a failure.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| path | string |
No | The path of the file to write. |
| text | string |
No | The text to write to the file. |
| encoding | string |
Yes | The encoding to use to write a text file. When omitted, utf-8 will be used. |
Returns Promise<void>
Properties
cacheDir
The path of a directory that the app may use to store cached files. The OS may delete files in this directory when the device runs low on storage. Only use this location for data that can easily be re-created.
| Type | string |
| Settable | No |
| Change events | No |
This property can only be set via constructor. Once set, it cannot change anymore.
filesDir
The path of a directory that the app may use to store persistent files. This is not the directory that contains the files bundled with the project, e.g. images, js files, package.json. You can access these files using the fetch or XMLHttpRequest APIs.
| Type | string |
| Settable | No |
| Change events | No |
This property can only be set via constructor. Once set, it cannot change anymore.
