diff options
Diffstat (limited to 'docs/src/api/functiondocs.md')
| -rw-r--r-- | docs/src/api/functiondocs.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index 3f1b214..2160ffe 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -861,7 +861,8 @@ from the configuration that is retrieved using the `proxy` JSON key connection from going over the VPN - `proxyReady` is a callback when the proxy is ready to be used. This is only called when the client is not connected yet. Use this to determine - when the actual wireguard connection can be started + when the actual wireguard connection can be started. This callback + returns and takes no arguments If the proxy cannot be started it returns an error |