mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
global: snapshot
This commit is contained in:
79
modules/brk-client/docs/interfaces/SkippedBuilder.md
Normal file
79
modules/brk-client/docs/interfaces/SkippedBuilder.md
Normal file
@@ -0,0 +1,79 @@
|
||||
[**brk-client**](../README.md)
|
||||
|
||||
***
|
||||
|
||||
[brk-client](../globals.md) / SkippedBuilder
|
||||
|
||||
# Interface: SkippedBuilder\<T\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:871](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L871)
|
||||
|
||||
## Type Parameters
|
||||
|
||||
### T
|
||||
|
||||
`T`
|
||||
|
||||
## Properties
|
||||
|
||||
### fetch()
|
||||
|
||||
> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:873](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L873)
|
||||
|
||||
Fetch from skipped position to end
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### onUpdate?
|
||||
|
||||
(`value`) => `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
|
||||
|
||||
***
|
||||
|
||||
### fetchCsv()
|
||||
|
||||
> **fetchCsv**: () => `Promise`\<`string`\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:874](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L874)
|
||||
|
||||
Fetch as CSV
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<`string`\>
|
||||
|
||||
***
|
||||
|
||||
### take()
|
||||
|
||||
> **take**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:872](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L872)
|
||||
|
||||
Take n items after skipped position
|
||||
|
||||
#### Parameters
|
||||
|
||||
##### n
|
||||
|
||||
`number`
|
||||
|
||||
#### Returns
|
||||
|
||||
[`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
||||
|
||||
***
|
||||
|
||||
### then
|
||||
|
||||
> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:875](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L875)
|
||||
|
||||
Thenable
|
||||
Reference in New Issue
Block a user