mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / BrkClientOptions
|
|
|
|
# Interface: BrkClientOptions
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:831](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L831)
|
|
|
|
## Properties
|
|
|
|
### baseUrl
|
|
|
|
> **baseUrl**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:832](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L832)
|
|
|
|
Base URL for the API
|
|
|
|
***
|
|
|
|
### cache?
|
|
|
|
> `optional` **cache**: `string` \| `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:834](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L834)
|
|
|
|
Enable browser cache with default name (true), custom name (string), or disable (false). No effect in Node.js. Default: true
|
|
|
|
***
|
|
|
|
### timeout?
|
|
|
|
> `optional` **timeout**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:833](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L833)
|
|
|
|
Request timeout in milliseconds
|