mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-09 06:31:57 -07:00
nym21
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / BrkClientOptions
|
|
|
|
# Interface: BrkClientOptions
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1450](https://github.com/bitcoinresearchkit/brk/blob/37e2b6eae2ee7db79b2d392e73eb0697e4a91b28/modules/brk-client/index.js#L1450)
|
|
|
|
## Properties
|
|
|
|
### baseUrl
|
|
|
|
> **baseUrl**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1451](https://github.com/bitcoinresearchkit/brk/blob/37e2b6eae2ee7db79b2d392e73eb0697e4a91b28/modules/brk-client/index.js#L1451)
|
|
|
|
Base URL for the API
|
|
|
|
***
|
|
|
|
### browserCache?
|
|
|
|
> `optional` **browserCache?**: `string` \| `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1453](https://github.com/bitcoinresearchkit/brk/blob/37e2b6eae2ee7db79b2d392e73eb0697e4a91b28/modules/brk-client/index.js#L1453)
|
|
|
|
Enable browser Cache API with default name (true), custom name (string), or disable (false). No effect in Node.js. Default: true
|
|
|
|
***
|
|
|
|
### memCache?
|
|
|
|
> `optional` **memCache?**: `number` \| `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1454](https://github.com/bitcoinresearchkit/brk/blob/37e2b6eae2ee7db79b2d392e73eb0697e4a91b28/modules/brk-client/index.js#L1454)
|
|
|
|
In-memory parsed-response cache size (LRU). true/undefined → 1000, false/0 → disabled. Lets 304 responses skip the JSON parse entirely. Default: 1000
|
|
|
|
***
|
|
|
|
### timeout?
|
|
|
|
> `optional` **timeout?**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1452](https://github.com/bitcoinresearchkit/brk/blob/37e2b6eae2ee7db79b2d392e73eb0697e4a91b28/modules/brk-client/index.js#L1452)
|
|
|
|
Request timeout in milliseconds
|