Interface ClientOptions

Options used by InfluxDB .

interface ClientOptions {
    headers?: Record<string, string>;
    proxyUrl?: string;
    timeout?: number;
    token?: string;
    transport?: Transport;
    transportOptions?: { [key: string]: any };
    url: string;
    writeOptions?: Partial<WriteOptions>;
}

Hierarchy (View Summary)

Properties

headers? proxyUrl? timeout? token? transport? transportOptions? url writeOptions?

Properties

Optionalheaders

headers?: Record<string, string>

Default HTTP headers to send with every request.

OptionalproxyUrl

proxyUrl?: string

Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

Optionaltimeout

timeout?: number

socket timeout, 10000 milliseconds by default in node.js

Default Value

10000

Optionaltoken

token?: string

authentication token

Optionaltransport

transport?: Transport

specifies custom transport

OptionaltransportOptions

transportOptions?: { [key: string]: any }

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.

url

url: string

base URL

OptionalwriteOptions

writeOptions?: Partial<WriteOptions>

supplies and overrides default writing options

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR