From 1b01ef971d01b3bfa234b0c9eb9bd9a421dcd683 Mon Sep 17 00:00:00 2001 From: Oliver Akins Date: Tue, 8 Mar 2022 13:23:59 -0600 Subject: [PATCH] Add documentation for the generic error event --- docs/events.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/events.md b/docs/events.md index 268ee2e..9d88c99 100644 --- a/docs/events.md +++ b/docs/events.md @@ -16,6 +16,22 @@ payloads inherit from the `ServerResponse` type. --- +## `error` +The event that is sent to clients when they cause a significant error to happen +in the server. When this is sent, the status property will never be set to a +value in the success range. + +### Supported Event Types +| Request | Response | Broadcasted +| ------- | -------- | ----------- +| No | Yes | No + +### Payloads +Request Payload: N/A + +Response Payload: `ServerResponse` +--- + ## `server.info` Retrieves information about the server that the client is currently connected to.