Skip to content

Commit 9213542

Browse files
github-actions[bot]github-actions[bot]
committed
Applying documentation updates.
1 parent fffff64 commit 9213542

File tree

202 files changed

+3327
-3326
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+3327
-3326
lines changed

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.activatecoreplugin.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [activateCorePlugin](./browser-tracker.coreplugin.activatecoreplugin.md)
4-
5-
## CorePlugin.activateCorePlugin property
6-
7-
Called when the plugin is initialised during the trackerCore construction
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
activateCorePlugin?: (core: TrackerCore) => void;
13-
```
14-
15-
## Remarks
16-
17-
Use to capture the specific core instance for each instance of a core plugin
18-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [activateCorePlugin](./browser-tracker.coreplugin.activatecoreplugin.md)
4+
5+
## CorePlugin.activateCorePlugin property
6+
7+
Called when the plugin is initialised during the trackerCore construction
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
activateCorePlugin?: (core: TrackerCore) => void;
13+
```
14+
15+
## Remarks
16+
17+
Use to capture the specific core instance for each instance of a core plugin
18+

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.aftertrack.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [afterTrack](./browser-tracker.coreplugin.aftertrack.md)
4-
5-
## CorePlugin.afterTrack property
6-
7-
Called just after the trackerCore callback fires
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
afterTrack?: (payload: Payload) => void;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [afterTrack](./browser-tracker.coreplugin.aftertrack.md)
4+
5+
## CorePlugin.afterTrack property
6+
7+
Called just after the trackerCore callback fires
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
afterTrack?: (payload: Payload) => void;
13+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.beforetrack.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [beforeTrack](./browser-tracker.coreplugin.beforetrack.md)
4-
5-
## CorePlugin.beforeTrack property
6-
7-
Called before the `filter` method is called and before the trackerCore callback fires (if the filter passes)
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
beforeTrack?: (payloadBuilder: PayloadBuilder) => void;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [beforeTrack](./browser-tracker.coreplugin.beforetrack.md)
4+
5+
## CorePlugin.beforeTrack property
6+
7+
Called before the `filter` method is called and before the trackerCore callback fires (if the filter passes)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
beforeTrack?: (payloadBuilder: PayloadBuilder) => void;
13+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.contexts.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [contexts](./browser-tracker.coreplugin.contexts.md)
4-
5-
## CorePlugin.contexts property
6-
7-
Called when constructing the context for each event Useful for adding additional context to events
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
contexts?: () => SelfDescribingJson[];
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [contexts](./browser-tracker.coreplugin.contexts.md)
4+
5+
## CorePlugin.contexts property
6+
7+
Called when constructing the context for each event Useful for adding additional context to events
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
contexts?: () => SelfDescribingJson[];
13+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.filter.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [filter](./browser-tracker.coreplugin.filter.md)
4-
5-
## CorePlugin.filter property
6-
7-
Called before the payload is sent to the callback to decide whether to send the payload or skip it
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
filter?: (payload: Payload) => boolean;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [filter](./browser-tracker.coreplugin.filter.md)
4+
5+
## CorePlugin.filter property
6+
7+
Called before the payload is sent to the callback to decide whether to send the payload or skip it
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
filter?: (payload: Payload) => boolean;
13+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.logger.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [logger](./browser-tracker.coreplugin.logger.md)
4-
5-
## CorePlugin.logger property
6-
7-
Passed a logger instance which can be used to send log information to the active logger
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
logger?: (logger: Logger) => void;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [logger](./browser-tracker.coreplugin.logger.md)
4+
5+
## CorePlugin.logger property
6+
7+
Passed a logger instance which can be used to send log information to the active logger
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
logger?: (logger: Logger) => void;
13+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md)
4-
5-
## CorePlugin interface
6-
7-
Interface which defines Core Plugins
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
interface CorePlugin
13-
```
14-
15-
## Properties
16-
17-
| Property | Type | Description |
18-
| --- | --- | --- |
19-
| [activateCorePlugin?](./browser-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
20-
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
21-
| [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) |
22-
| [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 |
23-
| [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 |
24-
| [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 |
25-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md)
4+
5+
## CorePlugin interface
6+
7+
Interface which defines Core Plugins
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface CorePlugin
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [activateCorePlugin?](./browser-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the plugin is initialised during the trackerCore construction |
20+
| [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
21+
| [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) |
22+
| [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 |
23+
| [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 |
24+
| [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 |
25+

‎api-docs/docs/browser-tracker/markdown/browser-tracker.corepluginconfiguration.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md)
4-
5-
## CorePluginConfiguration interface
6-
7-
The configuration of the plugin to add
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
interface CorePluginConfiguration
13-
```
14-
15-
## Properties
16-
17-
| Property | Type | Description |
18-
| --- | --- | --- |
19-
| [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | CorePlugin | |
20-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md)
4+
5+
## CorePluginConfiguration interface
6+
7+
The configuration of the plugin to add
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface CorePluginConfiguration
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [plugin](./browser-tracker.corepluginconfiguration.plugin.md) | CorePlugin | |
20+

‎api-docs/docs/browser-tracker/markdown/browser-tracker.corepluginconfiguration.plugin.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) &gt; [plugin](./browser-tracker.corepluginconfiguration.plugin.md)
4-
5-
## CorePluginConfiguration.plugin property
6-
7-
<b>Signature:</b>
8-
9-
```typescript
10-
plugin: CorePlugin;
11-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) &gt; [plugin](./browser-tracker.corepluginconfiguration.plugin.md)
4+
5+
## CorePluginConfiguration.plugin property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
plugin: CorePlugin;
11+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md)
4-
5-
## DeviceTimestamp interface
6-
7-
A representation of a Device Timestamp (dtm)
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
interface DeviceTimestamp
13-
```
14-
15-
## Properties
16-
17-
| Property | Type | Description |
18-
| --- | --- | --- |
19-
| [type](./browser-tracker.devicetimestamp.type.md) | "dtm" | |
20-
| [value](./browser-tracker.devicetimestamp.value.md) | number | |
21-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md)
4+
5+
## DeviceTimestamp interface
6+
7+
A representation of a Device Timestamp (dtm)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
interface DeviceTimestamp
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [type](./browser-tracker.devicetimestamp.type.md) | "dtm" | |
20+
| [value](./browser-tracker.devicetimestamp.value.md) | number | |
21+

‎api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.type.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [type](./browser-tracker.devicetimestamp.type.md)
4-
5-
## DeviceTimestamp.type property
6-
7-
<b>Signature:</b>
8-
9-
```typescript
10-
readonly type: "dtm";
11-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [type](./browser-tracker.devicetimestamp.type.md)
4+
5+
## DeviceTimestamp.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly type: "dtm";
11+
```

‎api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.value.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [value](./browser-tracker.devicetimestamp.value.md)
4-
5-
## DeviceTimestamp.value property
6-
7-
<b>Signature:</b>
8-
9-
```typescript
10-
readonly value: number;
11-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [DeviceTimestamp](./browser-tracker.devicetimestamp.md) &gt; [value](./browser-tracker.devicetimestamp.value.md)
4+
5+
## DeviceTimestamp.value property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly value: number;
11+
```

0 commit comments

Comments
 (0)