mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-30 09:30:00 -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:1209](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L1209)
|
|
|
|
## Properties
|
|
|
|
### baseUrl
|
|
|
|
> **baseUrl**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1210](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L1210)
|
|
|
|
Base URL for the API
|
|
|
|
***
|
|
|
|
### cache?
|
|
|
|
> `optional` **cache?**: `string` \| `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1212](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L1212)
|
|
|
|
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:1211](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L1211)
|
|
|
|
Request timeout in milliseconds
|