@atlaskit/editor-common/dist/types-ts4.5/analytics/api.d.ts

A package that contains common classes and components for editor and renderer

import type { Transaction } from '@atlaskit/editor-prosemirror/state';
import type { AnalyticsEventPayload } from './types/events';
export type EditorAnalyticsAPI = {
    /**
     * attachAnalyticsEvent is used to attach an analytics payloads to a transaction
     *
     * @param {AnalyticsEventPayload} payload - analytics payload
     * @param {string} [channel="editor"] - optional channel identifier
     * @param {Transaction} tr - a transaction
     * @return {boolean} true if submitted successful, false if not submitted
     */
    attachAnalyticsEvent: (payload: AnalyticsEventPayload, channel?: string) => (tr: Transaction) => boolean;
    /**
     * fireAnalyticsEvent is used to fire an analytics payloads directly
     *
     * @param {AnalyticsEventPayload} payload - analytics payload
     * @param {string} [channel="editor"] - optional channel identifier
     */
    fireAnalyticsEvent: (payload: AnalyticsEventPayload, channel?: string) => void | undefined;
};