Interface LoggingDataClient

Hierarchy

LoggingDataClient

Index

Methods

Methods

destroy

destroy(): void
Destroy the client. Always call this when the client is not used anymore. When the context is destroyed, this is called automatically

Returns void

query

query(query: LoggingDataQuery, listener: ((result: LoggingDataMetric[]) => any)): (() => void)
Starts a query for logging data. This method can be used for historic and live data depending on the selector.

Returns
Returns a deregistration function for the listener.
Parameters
- query: LoggingDataQuery
- listener: ((result: LoggingDataMetric[]) => any)
  - - (result: LoggingDataMetric[]): any
    - Parameters
      
      result: LoggingDataMetric[]
      
      Returns any
Returns (() => void)
- - (): void
  - Starts a query for logging data. This method can be used for historic and live data depending on the selector.
    
    Returns
    Returns a deregistration function for the listener.
    
    Returns void
query(queries: LoggingDataQuery[], listener: ((results: LoggingDataMetric[][]) => any)): (() => void)
Parameters
- queries: LoggingDataQuery[]
- listener: ((results: LoggingDataMetric[][]) => any)
  - - (results: LoggingDataMetric[][]): any
    - Parameters
      
      results: LoggingDataMetric[][]
      
      Returns any
Returns (() => void)
- - (): void
  - Returns void
query<T>(queryOptions: T, listener: ((results: T extends {
format: "csv";
} ? LoggingDataBlob : LoggingDataMetric[][]) => void)): (() => void)
Type Parameters
- T extends LoggingDataQueryOptions
Parameters
- queryOptions: T
- listener: ((results: T extends {
  format: "csv";
  } ? LoggingDataBlob : LoggingDataMetric[][]) => void)
  Depending on the format in the query options, the query listener result has a specific type.
  - If format is 'csv', the result type is LoggingDataBlob
  - Otherwise, the result type is LoggingDataMetric[][]
  - - (results: T extends {
      format: "csv";
      } ? LoggingDataBlob : LoggingDataMetric[][]): void
    - Depending on the format in the query options, the query listener result has a specific type.
      
      If format is 'csv', the result type is LoggingDataBlob
      
      Otherwise, the result type is LoggingDataMetric[][]
      
      Parameters
      
      results: T extends {
      format: "csv";
      } ? LoggingDataBlob : LoggingDataMetric[][]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void

Generated using TypeDoc