@exodus/analytics
Version: 0.0.0
Functions
Type Aliases
Variables
Analytics
interface
Properties
flush
any
identify
any
linkUserIds
any
requireDefaultEventProperties
any
requireDefaultProperties
any
setAnonymousId
any
setDefaultEventProperties
any
setDefaultProperties
any
setDefaultPropertiesForSanitizationErrors
any
setUserId
any
setUserTraits
any
track
any
trackInstall
any
AnalyticsApi
interface
Properties
analytics
any
AnalyticsApiConfig
type
AnalyticsIdentifyPayload
type
Properties
anonymousId?
string
force?
boolean
userId?
string
AnalyticsTrackPayload
type
analytics
variable
Type
const analytics: ({ segmentConfig: { apiKey, apiBaseUrl, preserveEventNames, preservePropertyKeys, }, keyIdentifier, installEventReportingUrl, }: AnalyticsApiConfig) => { ... }Signature
__type({ segmentConfig: { apiKey, apiBaseUrl, preserveEventNames, preservePropertyKeys, }, keyIdentifier, installEventReportingUrl, }: AnalyticsApiConfig): any
Parameters:
{ segmentConfig: { apiKey, apiBaseUrl, preserveEventNames, preservePropertyKeys, }, keyIdentifier, installEventReportingUrl, }: AnalyticsApiConfig
Returns:
anyProperties
definitions
any
id
"analytics"
Analytics
interface
Methods
flush
flush(): Promise
Returns:
Promiseidentify
identify(args: AnalyticsIdentifyPayload): Promise
Parameters:
args: AnalyticsIdentifyPayload
Returns:
PromiselinkUserIds
linkUserIds(__namedParameters: any): Promise
Parameters:
__namedParameters: any
Returns:
PromiserequireDefaultEventProperties
requireDefaultEventProperties(properties: string[]): void
Parameters:
properties: string[]
Returns:
voidrequireDefaultProperties
requireDefaultProperties(properties: string[]): void
Parameters:
properties: string[]
Returns:
voidsetAnonymousId
setAnonymousId(userId: string): void
Parameters:
userId: string
Returns:
voidsetDefaultEventProperties
setDefaultEventProperties(obj: Record): void
Parameters:
obj: Record
Returns:
voidsetDefaultProperties
setDefaultProperties(obj: Record): void
Parameters:
obj: Record
Returns:
voidsetDefaultPropertiesForSanitizationErrors
setDefaultPropertiesForSanitizationErrors(obj: Record): void
Parameters:
obj: Record
Returns:
voidsetUserId
setUserId(userId: string): void
Parameters:
userId: string
Returns:
voidsetUserTraits
setUserTraits(__namedParameters: AnalyticsIdentifyPayload): Promise
Parameters:
__namedParameters: AnalyticsIdentifyPayload
Returns:
Promisetrack
track(__namedParameters: AnalyticsTrackPayload): Promise
Parameters:
__namedParameters: AnalyticsTrackPayload
Returns:
PromisetrackInstall
trackInstall(): Promise
Returns:
PromiseAnalyticsApi
interface
Properties
analytics
any
AnalyticsApiConfig
type
AnalyticsIdentifyPayload
type
Properties
anonymousId?
string
force?
boolean
userId?
string
AnalyticsTrackPayload
type
analytics
function
Signature
analytics(__namedParameters: AnalyticsApiConfig): any
Parameters:
__namedParameters: AnalyticsApiConfig
