Skip to content

Commit

Permalink
Applying documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 28, 2024
1 parent fffff64 commit 9213542
Show file tree
Hide file tree
Showing 202 changed files with 3,327 additions and 3,326 deletions.
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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

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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [afterTrack](./browser-tracker.coreplugin.aftertrack.md)

## CorePlugin.afterTrack property

Called just after the trackerCore callback fires

<b>Signature:</b>

```typescript
afterTrack?: (payload: Payload) => void;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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[];
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [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;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
| [beforeTrack?](./browser-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) =&gt; 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) | () =&gt; 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) =&gt; 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) =&gt; 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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
| [beforeTrack?](./browser-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) =&gt; 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) | () =&gt; 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) =&gt; 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) =&gt; void | <i>(Optional)</i> Passed a logger instance which can be used to send log information to the active logger |

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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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 | |

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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) &gt; [plugin](./browser-tracker.corepluginconfiguration.plugin.md)

## CorePluginConfiguration.plugin property

<b>Signature:</b>

```typescript
plugin: CorePlugin;
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [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 | |

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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [type](./browser-tracker.devicetimestamp.type.md)

## DeviceTimestamp.type property

<b>Signature:</b>

```typescript
readonly type: "dtm";
```
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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [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) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [value](./browser-tracker.devicetimestamp.value.md)

## DeviceTimestamp.value property

<b>Signature:</b>

```typescript
readonly value: number;
```
Loading

0 comments on commit 9213542

Please sign in to comment.