1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-07 10:34:55 +00:00
CC-Tweaked/doc/events/http_check.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

21 lines
629 B
Markdown
Raw Normal View History

---
module: [kind=event] http_check
see: http.checkURLAsync To check a URL asynchronously.
---
<!--
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
SPDX-License-Identifier: LicenseRef-CCPL
-->
The @{http_check} event is fired when a URL check finishes.
This event is normally handled inside @{http.checkURL}, but it can still be seen when using @{http.checkURLAsync}.
## Return Values
1. @{string}: The event name.
2. @{string}: The URL requested to be checked.
3. @{boolean}: Whether the check succeeded.
2023-01-16 22:53:58 +00:00
4. <span class="type">@{string}|@{nil}</span>: If the check failed, a reason explaining why the check failed.