diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-02-22 16:24:15 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2024-02-23 10:40:50 +0100 |
| commit | f3ec2e1710c0bd616f6a1b00dcbdf29d3681107d (patch) | |
| tree | e52acbf0a7165d23f07fd264c1705d1ef4464993 /docs/src/api | |
| parent | 53faaee84188f9dde123087845d6ad90af23c2a4 (diff) | |
Export Docs: Mention that the proxyguard ready callback takes nothing
Diffstat (limited to 'docs/src/api')
| -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 |