Skip to main content
Defined in: packages/influx-utilities/src/lib/types.ts:3

Extends

  • Partial<ClientOptions>

Properties

headers?

optional headers?: Record<string, string>
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:690 Default HTTP headers to send with every request.

Inherited from

Partial.headers

org?

optional org?: string
Defined in: packages/influx-utilities/src/lib/types.ts:8 The URL to connect to.

Default


proxyUrl?

optional proxyUrl?: string
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:694 Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

Inherited from

Partial.proxyUrl

timeout?

optional timeout?: number
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:671 socket timeout, 10000 milliseconds by default in node.js

Default Value

Inherited from

Partial.timeout

token?

optional token?: string
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:666 authentication token

Inherited from

Partial.token

transport?

optional transport?: Transport
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:794 specifies custom transport

Inherited from

Partial.transport

transportOptions?

optional transportOptions?: object
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:684 TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. Node.js transport accepts options specified in http.request or https.request. For example, an agent property can be set to setup HTTP/HTTPS proxy, rejectUnauthorized property can disable TLS server certificate verification. Additionally, follow-redirects property can be also specified in order to follow redirects in node.js. fetch is used under the hood in browser/deno. For example, redirect property can be set to ‘error’ to abort request if a redirect occurs.

Index Signature

[key: string]: any

Inherited from

Partial.transportOptions

url?

optional url?: string
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:664 base URL

Inherited from

Partial.url

writeBucket?

optional writeBucket?: string
Defined in: packages/influx-utilities/src/lib/types.ts:14 The bucket to write to.

Default


writeOptions?

optional writeOptions?: Partial<WriteOptions>
Defined in: node_modules/.pnpm/@influxdata+influxdb-client@1.35.0/node_modules/@influxdata/influxdb-client/dist/index.d.ts:792 supplies and overrides default writing options

Inherited from

Partial.writeOptions

writePrecision?

optional writePrecision?: WritePrecisionType
Defined in: packages/influx-utilities/src/lib/types.ts:20 The precision of the timestamp.

Default