Class FluxScriptInvocationAPI

FluxScriptInvocationAPI executes flux 'API invokable script' and parses the result CSV annotated data. See https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/ .

Index

Constructors

Methods

Constructors

constructor

new FluxScriptInvocationAPI(
influxDB: InfluxDB,
options?: ExecutionOptions,
): FluxScriptInvocationAPI
Creates FluxScriptInvocationAPI with the supplied InfluxDB instance and a particular script identifier.
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
- Optionaloptions: ExecutionOptions
  script execution options
Returns FluxScriptInvocationAPI
- Defined in apis/src/custom/FluxScriptInvocationAPI.ts:30

Methods

invoke

invoke(scriptID: string, params?: Record<string, any>): AnnotatedCSVResponse
Invoke returns a parsed response data stream that executes the supplied script when asked for data.
Parameters
- scriptID: string
  script identifier
- Optionalparams: Record<string, any>
  script parameters
Returns AnnotatedCSVResponse
response with various methods to process data from the returned annotated CSV response data stream
- Defined in apis/src/custom/FluxScriptInvocationAPI.ts:44