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

brk-client

---

brk-client / SeriesSelection

Interface: SeriesSelection

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

Properties

end?

optional end?: number | null

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

Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: to, t, e

---

format?

optional format?: Format

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

Format of the output

---

index

index: Index

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

Index to query

---

limit?

optional limit?: number | null

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

Maximum number of values to return (ignored if end is set). Aliases: count, c, l

---

series

series: string

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

Requested series

---

start?

optional start?: number | null

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

Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: from, f, s