Interface ScreepsErrorResponse

Response returned by some endpoints when an issue occurs.

Despite the name/fields of this type, this response body is sent with an HTTP 200 status, so ScreepsHttpClient processes it as a normal response instead of an error.

See

ScreepsResponse for the standard success response
ScreepsApiError for the error type thrown by endpoint methods

interface ScreepsErrorResponse {
error: string;
ok: 1;
}

Hierarchy (View Summary)

ScreepsResponse
- ScreepsErrorResponse

Index

Properties

Properties

error

error: string

ok

ok: 1

An API success response always contains { ok: 1 }