Mirror/brk

mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-25 07:09:59 -07:00

Files

nym21 d54874d3a4 docs: update generated docs

2026-03-23 16:49:20 +01:00

1.7 KiB

Raw Blame History

brk-client / SeriesPattern

Interface: SeriesPattern<T>

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

Type Parameters

T

T

Properties

by

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

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

Index endpoints as lazy getters

get

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

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

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:1248

Get the list of available indexes

Returns

readonly Index[]

name

name: string

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

The series name