mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-05 23:23:05 -07:00
nym21
50 lines
1.4 KiB
Markdown
50 lines
1.4 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / ErrorDetail
|
|
|
|
# Interface: ErrorDetail
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:569](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L569)
|
|
|
|
## Properties
|
|
|
|
### code
|
|
|
|
> **code**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:571](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L571)
|
|
|
|
Machine-readable error code (e.g. "invalid_addr", "series_not_found")
|
|
|
|
***
|
|
|
|
### docUrl
|
|
|
|
> **docUrl**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:573](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L573)
|
|
|
|
Link to API documentation
|
|
|
|
***
|
|
|
|
### message
|
|
|
|
> **message**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:572](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L572)
|
|
|
|
Human-readable description
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> **type**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:570](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L570)
|
|
|
|
Error category: "invalid_request", "forbidden", "not_found", "unavailable", or "internal"
|