Skip to main content
Version: next 🚧

ObolApiErrorInit

Defined in: errors.ts:19

Options for constructing an ObolApiError.

Properties​

PropertyTypeDescriptionDefined in
statusnumberHTTP status code of the response.errors.ts:21
endpointstringRequest path relative to the base URL (e.g. /v1/definition).errors.ts:23
method?stringHTTP method of the request. Defaults to GET.errors.ts:25
body?unknownParsed JSON error body, or the raw text when the body is not JSON.errors.ts:27
hint?stringShort, actionable suggestion for the caller.errors.ts:29
headers?Pick<Headers, "get">Response headers, read for X-Request-Id (ObolApiError.requestId) and, on a 429, Retry-After (RateLimitError.retryAfterSeconds).errors.ts:34