brk/modules/brk-client/docs/interfaces/MetricPattern.md

brk-client

---

brk-client / MetricPattern

Interface: MetricPattern<T>

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

Type Parameters

T

T

Properties

by

by: Partial<Record<Index, MetricEndpoint<T>>>

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

Index endpoints (lazy getters)

---

get()

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

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

Get an endpoint for a specific index

Parameters

index

Index

Returns

MetricEndpoint<T> | undefined

---

indexes()

indexes: () => Index[]

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

Get the list of available indexes

Returns

Index[]

---

name

name: string

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

The metric name