Skip to content

Commit ffb1994

Browse files
Applying documentation updates.
1 parent 9188a6f commit ffb1994

File tree

4 files changed

+17
-2
lines changed

4 files changed

+17
-2
lines changed

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

+1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ interface Emitter
1616
| --- | --- | --- |
1717
| [flush](./node-tracker.emitter.flush.md) | () => void | |
1818
| [input](./node-tracker.emitter.input.md) | (payload: Payload) => void | |
19+
| [setAnonymization?](./node-tracker.emitter.setanonymization.md) | (shouldAnonymize: boolean) =&gt; void | <i>(Optional)</i> Set if the requests from the emitter should be anonymized. Read more about anonymization used at https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/http-headers/. |
1920

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [Emitter](./node-tracker.emitter.md) &gt; [setAnonymization](./node-tracker.emitter.setanonymization.md)
4+
5+
## Emitter.setAnonymization property
6+
7+
Set if the requests from the emitter should be anonymized. Read more about anonymization used at https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/http-headers/.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
setAnonymization?: (shouldAnonymize: boolean) => void;
13+
```

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Create an emitter object, which uses the `got` library, that will send events to
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial<RequiredRetryOptions>, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response<string>) => void, agents?: Agents): Emitter;
12+
declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial<RequiredRetryOptions>, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response<string>) => void, agents?: Agents, serverAnonymization?: boolean): Emitter;
1313
```
1414

1515
## Parameters
@@ -25,6 +25,7 @@ declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: nu
2525
| cookieJar | PromiseCookieJar \| ToughCookieJar | Add a cookieJar to <code>got</code> - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#cookiejar |
2626
| callback | (error?: RequestError, response?: Response&lt;string&gt;) =&gt; void | Callback called after a <code>got</code> request following retries - called with ErrorRequest (https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#errors) and Response (https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#response) |
2727
| agents | Agents | Set new http.Agent and https.Agent objects on <code>got</code> requests - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#agent |
28+
| serverAnonymization | boolean | If the request should undergo server anonymization. |
2829

2930
<b>Returns:</b>
3031

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
| [buildSiteSearch(event)](./node-tracker.buildsitesearch.md) | Build a Site Search Event Used when a user performs a search action on a page |
3535
| [buildSocialInteraction(event)](./node-tracker.buildsocialinteraction.md) | Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. |
3636
| [buildStructEvent(event)](./node-tracker.buildstructevent.md) | Build a Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. |
37-
| [gotEmitter(endpoint, protocol, port, method, bufferSize, retry, cookieJar, callback, agents)](./node-tracker.gotemitter.md) | Create an emitter object, which uses the <code>got</code> library, that will send events to a collector |
37+
| [gotEmitter(endpoint, protocol, port, method, bufferSize, retry, cookieJar, callback, agents, serverAnonymization)](./node-tracker.gotemitter.md) | Create an emitter object, which uses the <code>got</code> library, that will send events to a collector |
3838
| [tracker(emitters, namespace, appId, encodeBase64)](./node-tracker.tracker.md) | Snowplow Node.js Tracker |
3939

4040
## Interfaces

0 commit comments

Comments
 (0)