dev: documented HFS.prefixUrl
Massimo Melina committed
Jul 8, 2023 at 18:31 UTC
b0f58c168476c77a98d2634c974c6e259ba7a508
1 file changed
+3
dev-plugins.md
+3
@@ -1,5 +1,7 @@
1
# For plug-in makers
2
3
+If the information you are searching for is not in this document, [please ask](https://github.com/rejetto/hfs/discussions).
4
+
5
A plug-in is a folder with a `plugin.js` file in it.
6
7
Plug-ins can be hot-swapped, and at some extent can be edited without restarting the server.
@@ -172,6 +174,7 @@ The HFS objects contains many properties:
174
- `useApi`
175
- `reloadList`
176
- `logout`
177
+- `prefixUrl: string` normally an empty string, it will be set in case a [reverse-proxy wants to mount HFS on a path](https://github.com/rejetto/hfs/wiki/Reverse-proxy).
178
- `state` [object with many values in it](https://github.com/rejetto/hfs/blob/main/frontend/src/state.ts)
179
- `watchState: (key: string, callback)=>function`
180
- watch the `key` property of the state object above