UNPKG

posthog-js

Version:

Posthog-js allows you to automatically capture usage and send events to PostHog.

posthog.com/docs/libraries/js

PostHog/posthog-js

117 lines (116 loc) • 9.22 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
export declare const PEOPLE_DISTINCT_ID_KEY = "$people_distinct_id"; export declare const DISTINCT_ID = "distinct_id"; export declare const DEVICE_ID = "$device_id"; export declare const DEVICE_MODEL = "$device_model"; export declare const ALIAS_ID_KEY = "__alias"; export declare const CAMPAIGN_IDS_KEY = "__cmpns"; export declare const EVENT_TIMERS_KEY = "__timers"; export declare const AUTOCAPTURE_DISABLED_SERVER_SIDE = "$autocapture_disabled_server_side"; export declare const HEATMAPS_ENABLED_SERVER_SIDE = "$heatmaps_enabled_server_side"; export declare const EXCEPTION_CAPTURE_ENABLED_SERVER_SIDE = "$exception_capture_enabled_server_side"; export declare const ERROR_TRACKING_SUPPRESSION_RULES = "$error_tracking_suppression_rules"; export declare const ERROR_TRACKING_CAPTURE_EXTENSION_EXCEPTIONS = "$error_tracking_capture_extension_exceptions"; export declare const WEB_VITALS_ENABLED_SERVER_SIDE = "$web_vitals_enabled_server_side"; export declare const DEAD_CLICKS_ENABLED_SERVER_SIDE = "$dead_clicks_enabled_server_side"; export declare const PRODUCT_TOURS_ENABLED_SERVER_SIDE = "$product_tours_enabled_server_side"; export declare const LOGS_CAPTURE_ENABLED_SERVER_SIDE = "$logs_capture_enabled_server_side"; export declare const WEB_VITALS_ALLOWED_METRICS = "$web_vitals_allowed_metrics"; export declare const SESSION_RECORDING_REMOTE_CONFIG = "$session_recording_remote_config"; export declare const SESSION_RECORDING_ENABLED_SERVER_SIDE = "$session_recording_enabled_server_side"; export declare const CONSOLE_LOG_RECORDING_ENABLED_SERVER_SIDE = "$console_log_recording_enabled_server_side"; export declare const SESSION_RECORDING_NETWORK_PAYLOAD_CAPTURE = "$session_recording_network_payload_capture"; export declare const SESSION_RECORDING_MASKING = "$session_recording_masking"; export declare const SESSION_RECORDING_CANVAS_RECORDING = "$session_recording_canvas_recording"; export declare const SESSION_RECORDING_SAMPLE_RATE = "$replay_sample_rate"; export declare const SESSION_RECORDING_MINIMUM_DURATION = "$replay_minimum_duration"; export declare const SESSION_RECORDING_SCRIPT_CONFIG = "$replay_script_config"; export declare const SESSION_RECORDING_OVERRIDE_SAMPLING = "$replay_override_sampling"; export declare const SESSION_RECORDING_OVERRIDE_LINKED_FLAG = "$replay_override_linked_flag"; export declare const SESSION_RECORDING_OVERRIDE_URL_TRIGGER = "$replay_override_url_trigger"; export declare const SESSION_RECORDING_OVERRIDE_EVENT_TRIGGER = "$replay_override_event_trigger"; export declare const SESSION_ID = "$sesid"; export declare const SESSION_RECORDING_IS_SAMPLED = "$session_is_sampled"; export declare const SESSION_RECORDING_PAST_MINIMUM_DURATION = "$session_past_minimum_duration"; export declare const SESSION_RECORDING_URL_TRIGGER_ACTIVATED_SESSION = "$session_recording_url_trigger_activated_session"; export declare const SESSION_RECORDING_EVENT_TRIGGER_ACTIVATED_SESSION = "$session_recording_event_trigger_activated_session"; export declare const SESSION_RECORDING_TRIGGER_V2_GROUP_EVENT_PREFIX = "$posthog_sr_group_event_trigger_"; export declare const SESSION_RECORDING_TRIGGER_V2_GROUP_URL_PREFIX = "$posthog_sr_group_url_trigger_"; export declare const SESSION_RECORDING_TRIGGER_V2_GROUP_SAMPLING_PREFIX = "$posthog_sr_group_sampling_"; export declare const SESSION_RECORDING_FIRST_FULL_SNAPSHOT_TIMESTAMP = "$debug_first_full_snapshot_timestamp"; export declare const SESSION_RECORDING_FLUSHED_SIZE = "$sess_rec_flush_size"; export declare const ENABLED_FEATURE_FLAGS = "$enabled_feature_flags"; export declare const PERSISTENCE_ACTIVE_FEATURE_FLAGS = "$active_feature_flags"; export declare const PERSISTENCE_EARLY_ACCESS_FEATURES = "$early_access_features"; export declare const PERSISTENCE_FEATURE_FLAG_DETAILS = "$feature_flag_details"; export declare const PERSISTENCE_FEATURE_FLAG_PAYLOADS = "$feature_flag_payloads"; export declare const PERSISTENCE_FEATURE_FLAG_REQUEST_ID = "$feature_flag_request_id"; export declare const PERSISTENCE_MINIMAL_FLAG_CALLED_EVENTS = "$minimal_flag_called_events"; export declare const PERSISTENCE_OVERRIDE_FEATURE_FLAGS = "$override_feature_flags"; export declare const PERSISTENCE_OVERRIDE_FEATURE_FLAG_PAYLOADS = "$override_feature_flag_payloads"; export declare const STORED_PERSON_PROPERTIES_KEY = "$stored_person_properties"; export declare const STORED_GROUP_PROPERTIES_KEY = "$stored_group_properties"; export declare const GROUPS = "$groups"; export declare const SURVEYS = "$surveys"; export declare const SURVEYS_LOADED_AT = "$surveys_loaded_at"; export declare const SURVEYS_ACTIVATED = "$surveys_activated"; export declare const SURVEYS_ACTIVATED_SESSION = "$surveys_activated_session"; export declare const SURVEYS_ACTIVATED_TIMESTAMPS = "$surveys_activated_timestamps"; export declare const PRODUCT_TOURS = "ph_product_tours"; export declare const PRODUCT_TOURS_ACTIVATED = "$product_tours_activated"; export declare const PRODUCT_TOURS_ACTIVATED_SESSION = "$product_tours_activated_session"; export declare const CONVERSATIONS = "$conversations"; export declare const CONVERSATIONS_LEGACY_WIDGET_SESSION_ID = "$conversations_widget_session_id"; export declare const CONVERSATIONS_LEGACY_TICKET_ID = "$conversations_ticket_id"; export declare const CONVERSATIONS_LEGACY_WIDGET_STATE = "$conversations_widget_state"; export declare const CONVERSATIONS_LEGACY_USER_TRAITS = "$conversations_user_traits"; export declare const FLAG_CALL_REPORTED = "$flag_call_reported"; export declare const FLAG_CALL_REPORTED_SESSION_ID = "$flag_call_reported_session_id"; export declare const PERSISTENCE_FEATURE_FLAG_ERRORS = "$feature_flag_errors"; export declare const PERSISTENCE_FEATURE_FLAG_EVALUATED_AT = "$feature_flag_evaluated_at"; export declare const USER_STATE = "$user_state"; export declare const CLIENT_SESSION_PROPS = "$client_session_props"; export declare const CAPTURE_RATE_LIMIT = "$capture_rate_limit"; /** @deprecated Delete this when INITIAL_PERSON_INFO has been around for long enough to ignore backwards compat */ export declare const INITIAL_CAMPAIGN_PARAMS = "$initial_campaign_params"; /** @deprecated Delete this when INITIAL_PERSON_INFO has been around for long enough to ignore backwards compat */ export declare const INITIAL_REFERRER_INFO = "$initial_referrer_info"; export declare const INITIAL_PERSON_INFO = "$initial_person_info"; export declare const ENABLE_PERSON_PROCESSING = "$epp"; /** * PREVIEW - MAY CHANGE WITHOUT WARNING - DO NOT USE IN PRODUCTION * Sentinel value for distinct id, device id, session id. Signals that the server should generate the value * */ export declare const COOKIELESS_SENTINEL_VALUE = "$posthog_cookieless"; export declare const COOKIELESS_MODE_FLAG_PROPERTY = "$cookieless_mode"; export declare const WEB_EXPERIMENTS = "$web_experiments"; export declare const SDK_DEBUG_EXTENSIONS_INIT_METHOD = "$sdk_debug_extensions_init_method"; export declare const SDK_DEBUG_EXTENSIONS_INIT_TIME_MS = "$sdk_debug_extensions_init_time_ms"; export declare const SDK_DEBUG_RECORDING_SCRIPT_NOT_LOADED = "$sdk_debug_recording_script_not_loaded"; export declare const SDK_DEBUG_REPLAY_EVENT_TRIGGER_STATUS = "$sdk_debug_replay_event_trigger_status"; export declare const SDK_DEBUG_REPLAY_LINKED_FLAG_TRIGGER_STATUS = "$sdk_debug_replay_linked_flag_trigger_status"; export declare const SDK_DEBUG_REPLAY_MATCHED_RECORDING_TRIGGER_GROUPS = "$sdk_debug_replay_matched_recording_trigger_groups"; export declare const SDK_DEBUG_REPLAY_PENDING_TRIGGER_CONDITIONS = "$sdk_debug_replay_pending_trigger_conditions"; export declare const SDK_DEBUG_REPLAY_REMOTE_TRIGGER_MATCHING_CONFIG = "$sdk_debug_replay_remote_trigger_matching_config"; export declare const SDK_DEBUG_REPLAY_TRIGGER_GROUPS_COUNT = "$sdk_debug_replay_trigger_groups_count"; export declare const SDK_DEBUG_REPLAY_URL_TRIGGER_STATUS = "$sdk_debug_replay_url_trigger_status"; export declare const SDK_DEBUG_REPLAY_RRWEB_ATTACHED = "$sdk_debug_rrweb_attached"; export declare const SDK_DEBUG_REPLAY_RRWEB_START_ATTEMPTED = "$sdk_debug_rrweb_start_attempted"; export declare const SESSION_RECORDING_START_REASON = "$session_recording_start_reason"; export declare const SURVEYS_REQUEST_TIMEOUT_MS = 10000; export declare const SURVEYS_CACHE_TTL_MS: number; export declare const SURVEYS_REFRESH_BACKOFF_MS: number; export declare const LOAD_EXT_NOT_FOUND = "PostHog loadExternalDependency extension not found."; export declare const COOKIELESS_ON_REJECT: "on_reject"; export declare const COOKIELESS_ALWAYS: "always"; export declare const USER_STATE_ANONYMOUS = "anonymous"; export declare const USER_STATE_IDENTIFIED = "identified"; export declare const PERSON_PROFILES_IDENTIFIED_ONLY: "identified_only"; export declare const DOM_EVENT_VISIBILITYCHANGE = "visibilitychange"; export declare const DOM_EVENT_BEFOREUNLOAD = "beforeunload"; export declare const EVENT_PAGEVIEW = "$pageview"; export declare const EVENT_PAGELEAVE = "$pageleave"; export declare const EVENT_IDENTIFY = "$identify"; export declare const EVENT_GROUPIDENTIFY = "$groupidentify"; export declare const Z_INDEX_TOURS = 2147483646; export declare const Z_INDEX_SURVEYS = 2147483645; export declare const Z_INDEX_CONVERSATIONS = 2147483644;