UNPKG

@atlaskit/analytics-gas-types

Version:

Shared analytics functions/components for Fabric Elements

94 lines (68 loc) 2.08 kB
<!-- API Report Version: 2.3 --> ## API Report File for "@atlaskit/analytics-gas-types" > Do not edit this file. This report is auto-generated using > [API Extractor](https://api-extractor.com/). > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports) ### Table of contents - [Main Entry Types](#main-entry-types) - [Peer Dependencies](#peer-dependencies) ### Main Entry Types <!--SECTION START: Main Entry Types--> ```ts import { AnalyticsEventPayload } from '@atlaskit/analytics-next'; // @public (undocumented) export const DEFAULT_SOURCE = 'unknown'; // @public (undocumented) export type EventType = 'operational' | 'screen' | 'track' | 'ui'; // @public (undocumented) export type GasCorePayload = GasPurePayload & WithEventType; // @public (undocumented) export type GasPayload = AnalyticsEventPayload & GasCorePayload; // @public (undocumented) export type GasPurePayload = { actionSubject: string; actionSubjectId?: string; attributes?: { packageName?: string; packageVersion?: string; componentName?: string; [key: string]: any; }; nonPrivacySafeAttributes?: { [key: string]: any; }; tags?: Array<string>; source?: string; action?: string; }; // @public (undocumented) export type GasPureScreenEventPayload = { name: string; attributes?: { [key: string]: any; }; tags?: Array<string>; }; // @public (undocumented) export type GasScreenEventPayload = GasPureScreenEventPayload & WithEventType; // @public (undocumented) export const OPERATIONAL_EVENT_TYPE = 'operational'; // @public (undocumented) export const SCREEN_EVENT_TYPE = 'screen'; // @public (undocumented) export const TRACK_EVENT_TYPE = 'track'; // @public (undocumented) export const UI_EVENT_TYPE = 'ui'; // @public (undocumented) export type WithEventType = { eventType: EventType; }; // (No @packageDocumentation comment for this package) ``` <!--SECTION END: Main Entry Types--> ### Peer Dependencies <!--SECTION START: Peer Dependencies--> ```json {} ``` <!--SECTION END: Peer Dependencies-->