Skip to content

Commit de1f2d0

Browse files
committed
docs: update toc
1 parent 62fdee6 commit de1f2d0

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,12 @@ Here's a closer look at the Phoenix VFS organization:
2727

2828
- **Node Websocket Connector Integration**:
2929
- The `/tauri/` paths can be accessed via websockets. This integration is much more
30-
performant than tauri's fs rust APIs(generally 4x faster and 10x faster for large files).
30+
performant than Tauri's fs rust APIs(generally 4x faster and 10x faster for large files).
3131
- As we use websockets to connection to a node process that executes the actual fs operations,
3232
the ws backed `/tauri/` apis are available in all web/shared/service workers.
33-
- This is recommended to use in main browser window as well, as this will releive the main thread
33+
- This is recommended to use in main browser window as well, as this will relieve the main thread
3434
of tauri fs access apis that typically leads to blocking/freezing js window on large file access.
35-
- Supports filesystem watcher APIs. On all other endpoints, the virtual watchers are only capable of
36-
emitting file change events on files that has been modified within its window/browser only.
35+
- Supports filesystem watcher APIs that behaves consistently across all platforms.
3736

3837
By adopting Phoenix VFS, you're not just leveraging a file system; you're integrating a dynamic, adaptable layer that bridges the web and native worlds, making your web applications more powerful and reduces development time and costs.
3938

@@ -54,6 +53,7 @@ By adopting Phoenix VFS, you're not just leveraging a file system; you're integr
5453
* [API Docs](#api-docs)
5554
* [Error Codes](#error-codes)
5655
* [Supported file encodings](#supported-file-encodings)
56+
* [`fs.utils`](#fsutils)
5757
* [Usage of encoding in `fs.readFile` API](#usage-of-encoding-in-fsreadfile-api)
5858
* [Use `fs.BYTE_ARRAY_ENCODING` for binary files](#use-fsbytearrayencoding-for-binary-files)
5959
* [`fs.Buffer`](#fsbuffer)
@@ -97,12 +97,17 @@ By adopting Phoenix VFS, you're not just leveraging a file system; you're integr
9797
* [Stat Object](#stat-object)
9898
* [Example](#example-1)
9999
* [`fs.readFile(path, options?, callback)` Function](#fsreadfilepath-options-callback-function)
100-
* [`fs.writeFile(path, data, options?, callback)` Function](#fswritefilepath-data-options-callback-function)
101-
* [Parameters:](#parameters-7)
102-
* [Example:](#example-2)
103-
* [`fs.setNodeWSEndpoint(websocketEndpoint)`](#fssetnodewsendpointwebsocketendpoint)
104-
* [`fs.forceUseNodeWSEndpoint(use)`](#fsforceusenodewsendpointuse)
105-
* [`fs.preferNodeWSEndpoint(use)`](#fsprefernodewsendpointuse)
100+
* [`fs.writeFile(path, data, options?, callback)` Function](#fswritefilepath-data-options-callback-function)
101+
* [Parameters:](#parameters-7)
102+
* [Example:](#example-2)
103+
* [`fs.setNodeWSEndpoint(websocketEndpoint)`](#fssetnodewsendpointwebsocketendpoint)
104+
* [`fs.forceUseNodeWSEndpoint(use)`](#fsforceusenodewsendpointuse)
105+
* [`fs.preferNodeWSEndpoint(use)`](#fsprefernodewsendpointuse)
106+
* [`fs.watchAsync(pathToWatch, gitIgnorePaths)`](#fswatchasyncpathtowatch-gitignorepaths)
107+
* [Parameters](#parameters-8)
108+
* [Returns](#returns-4)
109+
* [Example](#example-3)
110+
* [`fs.unwatchAsync(eventEmitter)`](#fsunwatchasynceventemitter)
106111
<!-- TOC -->
107112

108113
## Installation

0 commit comments

Comments
 (0)