Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-05-20 23:04:46 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-05-08 00:35:52 +02:00
parent 6e8be1af22
commit 1643cf86ed
606 changed files with 5386 additions and 4545 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
modules/brk-client/docs/interfaces/BrkClientOptions.md
View File

@@ -6,7 +6,7 @@
# Interface: BrkClientOptions
Defined in: [Developer/brk/modules/brk-client/index.js:1296](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1296)
Defined in: [Developer/brk/modules/brk-client/index.js:1383](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1383)
## Properties
@@ -14,19 +14,29 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1296](https://github.com/
> **baseUrl**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:1297](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1297)
Defined in: [Developer/brk/modules/brk-client/index.js:1384](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1384)
Base URL for the API
***
### cache?
### browserCache?
> `optional` **cache?**: `string` \| `boolean`
> `optional` **browserCache?**: `string` \| `boolean`
Defined in: [Developer/brk/modules/brk-client/index.js:1299](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1299)
Defined in: [Developer/brk/modules/brk-client/index.js:1386](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1386)
Enable browser cache with default name (true), custom name (string), or disable (false). No effect in Node.js. Default: true
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:1387](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1387)
In-memory parsed-response cache size (LRU). true/undefined → 1000, false/0 → disabled. Lets 304 responses skip the JSON parse entirely. Default: 1000
***
@@ -34,6 +44,6 @@ Enable browser cache with default name (true), custom name (string), or disable
> `optional` **timeout?**: `number`
Defined in: [Developer/brk/modules/brk-client/index.js:1298](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1298)
Defined in: [Developer/brk/modules/brk-client/index.js:1385](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1385)
Request timeout in milliseconds