Mirror/brk

mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-06-30 06:02:10 -07:00

Files

T

nym21 565251f12f docs: update generated docs

2026-06-23 18:54:14 +02:00

1.7 KiB

Raw Blame History

brk-client / SeriesPattern

Interface: SeriesPattern<T>

Defined in: Developer/brk/modules/brk-client/index.js:1758

Type Parameters

T

T

Properties

by

by: Readonly<Partial<Record<Index, SeriesEndpoint<T>>>>

Defined in: Developer/brk/modules/brk-client/index.js:1760

Index endpoints as lazy getters

get

get: (index) => SeriesEndpoint<T> | undefined

Defined in: Developer/brk/modules/brk-client/index.js:1762

Get an endpoint for a specific index

Parameters

index

Returns

SeriesEndpoint<T> | undefined

indexes

indexes: () => readonly Index[]

Defined in: Developer/brk/modules/brk-client/index.js:1761

Get the list of available indexes

Returns

readonly Index[]

name

name: string

Defined in: Developer/brk/modules/brk-client/index.js:1759

The series name