Interface LoggingDataClient

interface LoggingDataClient {
    destroy(): void;
    query(query, listener): (() => void);
    query(queries, listener): (() => void);
    query<T>(queryOptions, listener): (() => void);
}

Methods

destroy query

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, listener): (() => void)

  • Starts a query for logging data. This method can be used for historic and live data depending on the selector.

    Parameters

    Returns (() => void)

    Returns a deregistration function for the listener.

      • (): void

      • Starts a query for logging data. This method can be used for historic and live data depending on the selector.

        Returns void

        Returns a deregistration function for the listener.

  • query(queries, listener): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

  • query<T>(queryOptions, listener): (() => void)

  • Type Parameters

    Parameters

    • queryOptions: T
    • listener: ((results) => 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): 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

          Returns void

    Returns (() => void)

      • (): void

      • Returns void

Settings

Member Visibility

Theme

On This Page