npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jibestream-dev/jmap-analytics-kit

v1.0.3

Published

Jibestream plugin for using Analytics

Downloads

3

Readme

AnalyticsKit

Jibestream plugin for using Analytics

Documentation

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions

constructor() ⇒ Object

Init method

Kind: global function
Returns: Object - AnalyticsKit

sharedInstance() ⇒ Object

Shared Instance singlton

Kind: global function
Returns: Object - AnalyticsKit

setloggingOptions(loggingOptions)

Optional API to set parameters to log in analytics.

Kind: global function

| Param | Type | | --- | --- | | loggingOptions | Array |

analyticsKitDidGetLog(callback)

Used to receive any recorded data in real time.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | callback | function | a function that can accept JSON. |

_setNotifiers()

method to registers all listeners to begin listening for notifiers within the SDK and route to the appropriate method. This method should be called in the class init file.

Kind: global function

_shouldLogOption(option) ⇒ Boolean

Used to check if log type sould be logged.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | option | String | log option name |

_recordTapOnShapeWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnIconWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordTapOnXYWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordLoadedMapCountWithData(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_startLoadFromServerEvent(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_endLoadFromServerEvent(name, data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | name | String | identifier | | data | object | to parse |

_endRecordMapParsingWithKey(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_recordWayfindPathWithValues(data)

helper method to parse and write to logs

Kind: global function

| Param | Type | Description | | --- | --- | --- | | data | object | to parse |

_makeTimestampForData(data) ⇒ object

creates timestamp in data object

Kind: global function
Returns: object - data

| Param | Type | Description | | --- | --- | --- | | data | Object | to write |

_recordCount(count, data) ⇒ Object

Helper method to record count and timestamp the event

Kind: global function
Returns: Object - with count and timestamp

| Param | Type | | --- | --- | | count | Number | | data | Object |

_startEventWithTimerKey(timerKey)

Create and save a time key

Kind: global function

| Param | Type | | --- | --- | | timerKey | String |

_endEventWithTimerKey(timerKey) ⇒ Object

Log event with the timer key

Kind: global function
Returns: Object - with all timestamp details

| Param | Type | | --- | --- | | timerKey | String |

Functions