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

Type Parameters

T

T

Properties

by

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

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

Index endpoints as lazy getters. Access via .by.dateindex or .by['dateindex']

---

get()

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

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

Get an endpoint for a specific index

Parameters

index

Index

Returns

MetricEndpointBuilder<T> | undefined

---

indexes()

indexes: () => readonly Index[]

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

Get the list of available indexes

Returns

readonly Index[]

---

name

name: string

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

The metric name