Skip to content

Commit ffa44ff

Browse files
committed
Make base64 encoding an optional parameter in Node newTracker call (#1354)
1 parent 0b97285 commit ffa44ff

14 files changed

+40
-20
lines changed

api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingevent.event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The Self Describing JSON which describes the event
99
<b>Signature:</b>
1010

1111
```typescript
12-
event: SelfDescribingJson;
12+
event: SelfDescribingJson<T>;
1313
```

api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingevent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ A Self Describing Event A custom event type, allowing for an event to be tracked
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface SelfDescribingEvent
12+
interface SelfDescribingEvent<T = Record<string, unknown>>
1313
```
1414

1515
## Properties
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [event](./browser-tracker.selfdescribingevent.event.md) | SelfDescribingJson | The Self Describing JSON which describes the event |
19+
| [event](./browser-tracker.selfdescribingevent.event.md) | SelfDescribingJson&lt;T&gt; | The Self Describing JSON which describes the event |
2020

api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingjson.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Export interface for any Self-Describing JSON such as context or Self Describing
99
<b>Signature:</b>
1010

1111
```typescript
12-
type SelfDescribingJson<T extends Record<keyof T, unknown> = Record<string, unknown>> = {
12+
type SelfDescribingJson<T = Record<string, unknown>> = {
1313
schema: string;
14-
data: T;
14+
data: T extends any[] ? never : T extends {} ? T : never;
1515
};
1616
```

api-docs/docs/browser-tracker/markdown/browser-tracker.trackselfdescribingevent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Track a self-describing event happening on this page. A custom event type, allow
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array<string>): void;
12+
declare function trackSelfDescribingEvent<T = Record<string, unknown>>(event: SelfDescribingEvent<T> & CommonEventProperties, trackers?: Array<string>): void;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | SelfDescribingEvent &amp; CommonEventProperties | The event information |
19+
| event | SelfDescribingEvent&lt;T&gt; &amp; CommonEventProperties | The event information |
2020
| trackers | Array&lt;string&gt; | The tracker identifiers which the event will be sent to |
2121

2222
<b>Returns:</b>

api-docs/docs/node-tracker/markdown/node-tracker.buildselfdescribingevent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Build a self-describing event A custom event type, allowing for an event to be t
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function buildSelfDescribingEvent(event: SelfDescribingEvent): PayloadBuilder;
12+
declare function buildSelfDescribingEvent<T = Record<string, unknown>>(event: SelfDescribingEvent<T>): PayloadBuilder;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| event | SelfDescribingEvent | Contains the properties and schema location for the event |
19+
| event | SelfDescribingEvent&lt;T&gt; | Contains the properties and schema location for the event |
2020

2121
<b>Returns:</b>
2222

api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The Self Describing JSON which describes the event
99
<b>Signature:</b>
1010

1111
```typescript
12-
event: SelfDescribingJson;
12+
event: SelfDescribingJson<T>;
1313
```

api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingevent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ A Self Describing Event A custom event type, allowing for an event to be tracked
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface SelfDescribingEvent
12+
interface SelfDescribingEvent<T = Record<string, unknown>>
1313
```
1414

1515
## Properties
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [event](./node-tracker.selfdescribingevent.event.md) | SelfDescribingJson | The Self Describing JSON which describes the event |
19+
| [event](./node-tracker.selfdescribingevent.event.md) | SelfDescribingJson&lt;T&gt; | The Self Describing JSON which describes the event |
2020

api-docs/docs/node-tracker/markdown/node-tracker.selfdescribingjson.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Export interface for any Self-Describing JSON such as context or Self Describing
99
<b>Signature:</b>
1010

1111
```typescript
12-
type SelfDescribingJson<T extends Record<keyof T, unknown> = Record<string, unknown>> = {
12+
type SelfDescribingJson<T = Record<string, unknown>> = {
1313
schema: string;
14-
data: T;
14+
data: T extends any[] ? never : T extends {} ? T : never;
1515
};
1616
```

api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.encodebase64.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44

55
## TrackerConfiguration.encodeBase64 property
66

7+
Whether unstructured events and custom contexts should be base64 encoded.
8+
79
<b>Signature:</b>
810

911
```typescript
10-
encodeBase64: boolean;
12+
encodeBase64?: boolean;
1113
```

api-docs/docs/node-tracker/markdown/node-tracker.trackerconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ interface TrackerConfiguration
1515
| Property | Type | Description |
1616
| --- | --- | --- |
1717
| [appId](./node-tracker.trackerconfiguration.appid.md) | string | |
18-
| [encodeBase64](./node-tracker.trackerconfiguration.encodebase64.md) | boolean | |
18+
| [encodeBase64?](./node-tracker.trackerconfiguration.encodebase64.md) | boolean | <i>(Optional)</i> Whether unstructured events and custom contexts should be base64 encoded. |
1919
| [namespace](./node-tracker.trackerconfiguration.namespace.md) | string | |
2020

0 commit comments

Comments
 (0)