CC-Tweaked/doc/events/http_check.md

---
module: [kind=event] http_check
see: http.checkURLAsync To check a URL asynchronously.
---

<!--
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers

SPDX-License-Identifier: MPL-2.0
-->

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.
4. <span class="type">[`string`]|[`nil`]</span>: If the check failed, a reason explaining why the check failed.
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00			`---`
			`module: [kind=event] http_check`
			`see: http.checkURLAsync To check a URL asynchronously.`
			`---`

License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/ 2023-03-15 21:52:13 +00:00			`<!--`
			`SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers`

Re-license several more files under MPL-2.0 - Several files where @MCJack123 is the exclusive contributor. He has signed over all contributions to "any OSI-approved license". Thank you! - Various the file handle classes: Looking at these again, I don't think they contain any of the original code. 2023-03-28 09:23:28 +00:00			`SPDX-License-Identifier: MPL-2.0`
License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/ 2023-03-15 21:52:13 +00:00			`-->`

Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print\|print a string}. 2023-08-24 09:48:30 +00:00			The [`http_check`] event is fired when a URL check finishes.
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00
Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print\|print a string}. 2023-08-24 09:48:30 +00:00			This event is normally handled inside [`http.checkURL`], but it can still be seen when using [`http.checkURLAsync`].
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00
			`## Return Values`
Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print\|print a string}. 2023-08-24 09:48:30 +00:00			1. [`string`]: The event name.
			2. [`string`]: The URL requested to be checked.
			3. [`boolean`]: Whether the check succeeded.
			4. <span class="type">[`string`]\|[`nil`]</span>: If the check failed, a reason explaining why the check failed.