From f3ec2e1710c0bd616f6a1b00dcbdf29d3681107d Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Thu, 22 Feb 2024 16:24:15 +0100 Subject: Export Docs: Mention that the proxyguard ready callback takes nothing --- docs/src/api/functiondocs.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') 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 -- cgit v1.2.3