docs: update generated docs

2026-04-24 14:49:58 -07:00 · 2026-03-23 16:45:58 +01:00
parent c4c0004c4a
commit 0d2deb1b63
780 changed files with 23664 additions and 18747 deletions
--- a/modules/brk-client/docs/interfaces/SeriesEndpoint.md
+++ b/modules/brk-client/docs/interfaces/SeriesEndpoint.md
@@ -0,0 +1,173 @@
+[**brk-client**](../README.md)
+
+***
+
+[brk-client](../globals.md) / SeriesEndpoint
+
+# Interface: SeriesEndpoint\<T\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1177)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### fetch
+
+> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1183)
+
+Fetch all data
+
+#### Parameters
+
+##### onUpdate?
+
+(`value`) => `void`
+
+#### Returns
+
+`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
+
+***
+
+### fetchCsv
+
+> **fetchCsv**: () => `Promise`\<`string`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1184)
+
+Fetch all data as CSV
+
+#### Returns
+
+`Promise`\<`string`\>
+
+***
+
+### first
+
+> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1180](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1180)
+
+Get first n items
+
+#### Parameters
+
+##### n
+
+`number`
+
+#### Returns
+
+[`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+***
+
+### get
+
+> **get**: (`index`) => [`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1178)
+
+Get single item at index
+
+#### Parameters
+
+##### index
+
+`number`
+
+#### Returns
+
+[`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\>
+
+***
+
+### last
+
+> **last**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1181](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1181)
+
+Get last n items
+
+#### Parameters
+
+##### n
+
+`number`
+
+#### Returns
+
+[`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1186](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1186)
+
+The endpoint path
+
+***
+
+### skip
+
+> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1182](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1182)
+
+Skip first n items, chain with take()
+
+#### Parameters
+
+##### n
+
+`number`
+
+#### Returns
+
+[`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
+
+***
+
+### slice
+
+> **slice**: (`start?`, `end?`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1179](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1179)
+
+Slice by index
+
+#### Parameters
+
+##### start?
+
+`number`
+
+##### end?
+
+`number`
+
+#### Returns
+
+[`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+***
+
+### then
+
+> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:1185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1185)
+
+Thenable (await endpoint)