Class: Client

Defined in: packages/influx-utilities/src/lib/Client.ts:5

​

Constructors

​

Constructor

new Client(options?): Client

Defined in: packages/influx-utilities/src/lib/Client.ts:12

​

Parameters

options?

ConnectionOptions = {}

​

Returns

Client

​

Properties

​

influx

readonly influx: InfluxDB

Defined in: packages/influx-utilities/src/lib/Client.ts:6

---

​

queryApi

readonly queryApi: QueryApi

Defined in: packages/influx-utilities/src/lib/Client.ts:7

---

​

writeApi

readonly writeApi: WriteApi

Defined in: packages/influx-utilities/src/lib/Client.ts:8

​

Methods

​

addInjectTag()

addInjectTag(name, value): void

Defined in: packages/influx-utilities/src/lib/Client.ts:28 Adds a tag that will be injected in all points.

​

Parameters

name

string The name of the tag to inject.

value

string The value of the tag to inject.

​

Returns

void

---

​

flush()

flush(withRetryBuffer?): Promise<void>

Defined in: packages/influx-utilities/src/lib/Client.ts:52 Flushes the pending writes to the server.

​

Parameters

withRetryBuffer?

boolean Whether or not it should flush the scheduled retries

​

Returns

Promise<void>

---

​

writePoint()

writePoint(point): void

Defined in: packages/influx-utilities/src/lib/Client.ts:36 Writes a point into the write buffer.

​

Parameters

point

Point The point to write.

​

Returns

void

---

​

writePoints()

writePoints(points): void

Defined in: packages/influx-utilities/src/lib/Client.ts:44 Writes multiple points into the write buffer.

​

Parameters

points

readonly Point[] The points to write.

​

Returns

void