mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-08 00: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:561](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L561)
|
|
|
|
## Properties
|
|
|
|
### code
|
|
|
|
> **code**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L563)
|
|
|
|
Machine-readable error code (e.g. "invalid_addr", "series_not_found")
|
|
|
|
***
|
|
|
|
### docUrl
|
|
|
|
> **docUrl**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:565](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L565)
|
|
|
|
Link to API documentation
|
|
|
|
***
|
|
|
|
### message
|
|
|
|
> **message**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:564](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L564)
|
|
|
|
Human-readable description
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> **type**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:562](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L562)
|
|
|
|
Error category: "invalid_request", "forbidden", "not_found", "unavailable", or "internal"
|