-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fffff64
commit 9213542
Showing
202 changed files
with
3,327 additions
and
3,326 deletions.
There are no files selected for viewing
36 changes: 18 additions & 18 deletions
36
.../docs/browser-tracker/markdown/browser-tracker.coreplugin.activatecoreplugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [activateCorePlugin](./browser-tracker.coreplugin.activatecoreplugin.md) | ||
|
||
## CorePlugin.activateCorePlugin property | ||
|
||
Called when the plugin is initialised during the trackerCore construction | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
activateCorePlugin?: (core: TrackerCore) => void; | ||
``` | ||
|
||
## Remarks | ||
|
||
Use to capture the specific core instance for each instance of a core plugin | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [activateCorePlugin](./browser-tracker.coreplugin.activatecoreplugin.md) | ||
|
||
## CorePlugin.activateCorePlugin property | ||
|
||
Called when the plugin is initialised during the trackerCore construction | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
activateCorePlugin?: (core: TrackerCore) => void; | ||
``` | ||
|
||
## Remarks | ||
|
||
Use to capture the specific core instance for each instance of a core plugin | ||
|
26 changes: 13 additions & 13 deletions
26
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.aftertrack.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [afterTrack](./browser-tracker.coreplugin.aftertrack.md) | ||
|
||
## CorePlugin.afterTrack property | ||
|
||
Called just after the trackerCore callback fires | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
afterTrack?: (payload: Payload) => void; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [afterTrack](./browser-tracker.coreplugin.aftertrack.md) | ||
|
||
## CorePlugin.afterTrack property | ||
|
||
Called just after the trackerCore callback fires | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
afterTrack?: (payload: Payload) => void; | ||
``` |
26 changes: 13 additions & 13 deletions
26
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.beforetrack.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [beforeTrack](./browser-tracker.coreplugin.beforetrack.md) | ||
|
||
## CorePlugin.beforeTrack property | ||
|
||
Called before the `filter` method is called and before the trackerCore callback fires (if the filter passes) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
beforeTrack?: (payloadBuilder: PayloadBuilder) => void; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [beforeTrack](./browser-tracker.coreplugin.beforetrack.md) | ||
|
||
## CorePlugin.beforeTrack property | ||
|
||
Called before the `filter` method is called and before the trackerCore callback fires (if the filter passes) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
beforeTrack?: (payloadBuilder: PayloadBuilder) => void; | ||
``` |
26 changes: 13 additions & 13 deletions
26
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.contexts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [contexts](./browser-tracker.coreplugin.contexts.md) | ||
|
||
## CorePlugin.contexts property | ||
|
||
Called when constructing the context for each event Useful for adding additional context to events | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
contexts?: () => SelfDescribingJson[]; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [contexts](./browser-tracker.coreplugin.contexts.md) | ||
|
||
## CorePlugin.contexts property | ||
|
||
Called when constructing the context for each event Useful for adding additional context to events | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
contexts?: () => SelfDescribingJson[]; | ||
``` |
26 changes: 13 additions & 13 deletions
26
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.filter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [filter](./browser-tracker.coreplugin.filter.md) | ||
|
||
## CorePlugin.filter property | ||
|
||
Called before the payload is sent to the callback to decide whether to send the payload or skip it | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
filter?: (payload: Payload) => boolean; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [filter](./browser-tracker.coreplugin.filter.md) | ||
|
||
## CorePlugin.filter property | ||
|
||
Called before the payload is sent to the callback to decide whether to send the payload or skip it | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
filter?: (payload: Payload) => boolean; | ||
``` |
26 changes: 13 additions & 13 deletions
26
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.logger.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [logger](./browser-tracker.coreplugin.logger.md) | ||
|
||
## CorePlugin.logger property | ||
|
||
Passed a logger instance which can be used to send log information to the active logger | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
logger?: (logger: Logger) => void; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [logger](./browser-tracker.coreplugin.logger.md) | ||
|
||
## CorePlugin.logger property | ||
|
||
Passed a logger instance which can be used to send log information to the active logger | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
logger?: (logger: Logger) => void; | ||
``` |
50 changes: 25 additions & 25 deletions
50
api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) | ||
|
||
## CorePlugin interface | ||
|
||
Interface which defines Core Plugins | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface CorePlugin | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [activateCorePlugin?](./browser-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) => void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction | | ||
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) => void | <i>(Optional)</i> Called just after the trackerCore callback fires | | ||
| [beforeTrack?](./browser-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) => void | <i>(Optional)</i> Called before the <code>filter</code> method is called and before the trackerCore callback fires (if the filter passes) | | ||
| [contexts?](./browser-tracker.coreplugin.contexts.md) | () => SelfDescribingJson\[\] | <i>(Optional)</i> Called when constructing the context for each event Useful for adding additional context to events | | ||
| [filter?](./browser-tracker.coreplugin.filter.md) | (payload: Payload) => boolean | <i>(Optional)</i> Called before the payload is sent to the callback to decide whether to send the payload or skip it | | ||
| [logger?](./browser-tracker.coreplugin.logger.md) | (logger: Logger) => void | <i>(Optional)</i> Passed a logger instance which can be used to send log information to the active logger | | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) | ||
|
||
## CorePlugin interface | ||
|
||
Interface which defines Core Plugins | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface CorePlugin | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [activateCorePlugin?](./browser-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) => void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction | | ||
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) => void | <i>(Optional)</i> Called just after the trackerCore callback fires | | ||
| [beforeTrack?](./browser-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) => void | <i>(Optional)</i> Called before the <code>filter</code> method is called and before the trackerCore callback fires (if the filter passes) | | ||
| [contexts?](./browser-tracker.coreplugin.contexts.md) | () => SelfDescribingJson\[\] | <i>(Optional)</i> Called when constructing the context for each event Useful for adding additional context to events | | ||
| [filter?](./browser-tracker.coreplugin.filter.md) | (payload: Payload) => boolean | <i>(Optional)</i> Called before the payload is sent to the callback to decide whether to send the payload or skip it | | ||
| [logger?](./browser-tracker.coreplugin.logger.md) | (logger: Logger) => void | <i>(Optional)</i> Passed a logger instance which can be used to send log information to the active logger | | ||
|
40 changes: 20 additions & 20 deletions
40
api-docs/docs/browser-tracker/markdown/browser-tracker.corepluginconfiguration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) | ||
|
||
## CorePluginConfiguration interface | ||
|
||
The configuration of the plugin to add | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface CorePluginConfiguration | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | CorePlugin | | | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) | ||
|
||
## CorePluginConfiguration interface | ||
|
||
The configuration of the plugin to add | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface CorePluginConfiguration | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | CorePlugin | | | ||
|
22 changes: 11 additions & 11 deletions
22
...docs/browser-tracker/markdown/browser-tracker.corepluginconfiguration.plugin.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) > [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | ||
|
||
## CorePluginConfiguration.plugin property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
plugin: CorePlugin; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) > [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | ||
|
||
## CorePluginConfiguration.plugin property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
plugin: CorePlugin; | ||
``` |
42 changes: 21 additions & 21 deletions
42
api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) | ||
|
||
## DeviceTimestamp interface | ||
|
||
A representation of a Device Timestamp (dtm) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface DeviceTimestamp | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [type](./browser-tracker.devicetimestamp.type.md) | "dtm" | | | ||
| [value](./browser-tracker.devicetimestamp.value.md) | number | | | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) | ||
|
||
## DeviceTimestamp interface | ||
|
||
A representation of a Device Timestamp (dtm) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
interface DeviceTimestamp | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [type](./browser-tracker.devicetimestamp.type.md) | "dtm" | | | ||
| [value](./browser-tracker.devicetimestamp.value.md) | number | | | ||
|
22 changes: 11 additions & 11 deletions
22
api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [type](./browser-tracker.devicetimestamp.type.md) | ||
|
||
## DeviceTimestamp.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly type: "dtm"; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [type](./browser-tracker.devicetimestamp.type.md) | ||
|
||
## DeviceTimestamp.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly type: "dtm"; | ||
``` |
22 changes: 11 additions & 11 deletions
22
api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.value.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [value](./browser-tracker.devicetimestamp.value.md) | ||
|
||
## DeviceTimestamp.value property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly value: number; | ||
``` | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [value](./browser-tracker.devicetimestamp.value.md) | ||
|
||
## DeviceTimestamp.value property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly value: number; | ||
``` |
Oops, something went wrong.