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 Jan 29, 2024
1 parent 9188a6f commit ffb1994
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ interface Emitter
| --- | --- | --- |
| [flush](./node-tracker.emitter.flush.md) | () => void | |
| [input](./node-tracker.emitter.input.md) | (payload: Payload) => void | |
| [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/. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [Emitter](./node-tracker.emitter.md) &gt; [setAnonymization](./node-tracker.emitter.setanonymization.md)

## Emitter.setAnonymization property

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/.

<b>Signature:</b>

```typescript
setAnonymization?: (shouldAnonymize: boolean) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Create an emitter object, which uses the `got` library, that will send events to
<b>Signature:</b>

```typescript
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;
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;
```

## Parameters
Expand All @@ -25,6 +25,7 @@ declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: nu
| cookieJar | PromiseCookieJar \| ToughCookieJar | Add a cookieJar to <code>got</code> - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#cookiejar |
| 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) |
| 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 |
| serverAnonymization | boolean | If the request should undergo server anonymization. |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion api-docs/docs/node-tracker/markdown/node-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
| [buildSiteSearch(event)](./node-tracker.buildsitesearch.md) | Build a Site Search Event Used when a user performs a search action on a page |
| [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. |
| [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. |
| [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 |
| [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 |
| [tracker(emitters, namespace, appId, encodeBase64)](./node-tracker.tracker.md) | Snowplow Node.js Tracker |

## Interfaces
Expand Down

0 comments on commit ffb1994

Please sign in to comment.