global: snapshot

2026-04-24 14:49:58 -07:00 · 2026-01-14 22:20:23 +01:00
parent 8a938c00f6
commit 467dfcc4b8
487 changed files with 17409 additions and 14029 deletions
--- a/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md
+++ b/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md
@@ -0,0 +1,173 @@
+[**brk-client**](../README.md)
+
+***
+
+[brk-client](../globals.md) / MetricEndpointBuilder
+
+# Interface: MetricEndpointBuilder\<T\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:848](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L848)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### fetch()
+
+> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:854](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L854)
+
+Fetch all data
+
+#### Parameters
+
+##### onUpdate?
+
+(`value`) => `void`
+
+#### Returns
+
+`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
+
+***
+
+### fetchCsv()
+
+> **fetchCsv**: () => `Promise`\<`string`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:855](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L855)
+
+Fetch all data as CSV
+
+#### Returns
+
+`Promise`\<`string`\>
+
+***
+
+### first()
+
+> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:851](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L851)
+
+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:849](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L849)
+
+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:852](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L852)
+
+Get last n items
+
+#### Parameters
+
+##### n
+
+`number`
+
+#### Returns
+
+[`RangeBuilder`](RangeBuilder.md)\<`T`\>
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [Developer/brk/modules/brk-client/index.js:857](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L857)
+
+The endpoint path
+
+***
+
+### skip()
+
+> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
+
+Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L853)
+
+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:850](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L850)
+
+Slice like Array.slice
+
+#### 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:856](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L856)
+
+Thenable (await endpoint)