@openshift-console/dynamic-plugin-sdk-internal/lib/api/internal-console-api.d.ts

Internal package exposing additional Console code.

import { GetSegmentAnalytics } from '../extensions/console-types';
/**
 * Allows integration with Console specific Segment Analytics instance.
 *
 * This API is meant to be used by Red Hat plugins only.
 *
 * Console application takes care of loading the analytics.min.js script.
 *
 * @example
 * ```ts
 * const { analytics, analyticsEnabled } = getSegmentAnalytics();
 *
 * if (analyticsEnabled) {
 *   // invoke methods on analytics object as needed
 * }
 * ```
 *
 * @see https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/
 */
export declare const getSegmentAnalytics: GetSegmentAnalytics;