mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-26 07:39:59 -07:00
174 lines
3.5 KiB
Markdown
174 lines
3.5 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / MetricEndpointBuilder
|
|
|
|
# Interface: MetricEndpointBuilder\<T\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:967](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L967)
|
|
|
|
## Type Parameters
|
|
|
|
### T
|
|
|
|
`T`
|
|
|
|
## Properties
|
|
|
|
### fetch()
|
|
|
|
> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:973](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L973)
|
|
|
|
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:974](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L974)
|
|
|
|
Fetch all data as CSV
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`string`\>
|
|
|
|
***
|
|
|
|
### first()
|
|
|
|
> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:970](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L970)
|
|
|
|
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:968](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L968)
|
|
|
|
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:971](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L971)
|
|
|
|
Get last n items
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### path
|
|
|
|
> **path**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:976](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L976)
|
|
|
|
The endpoint path
|
|
|
|
***
|
|
|
|
### skip()
|
|
|
|
> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:972](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L972)
|
|
|
|
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:969](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L969)
|
|
|
|
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:975](https://github.com/bitcoinresearchkit/brk/blob/54827cd0a2357417adb8631eb8f53a78e848b39a/modules/brk-client/index.js#L975)
|
|
|
|
Thenable (await endpoint)
|