# @types/keen-tracking

> TypeScript definitions for keen-tracking

Latest version **4.5.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/keen-tracking
pnpm add @types/keen-tracking
yarn add @types/keen-tracking
bun add @types/keen-tracking
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.5.3 |
| Published | 2023-11-07 |
| First published | 2018-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/keen-tracking
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keen-tracking
- npm.io page: https://npm.io/package/@types/keen-tracking

## Recent versions

- 4.5.3 (latest) — 2023-11-07
- 4.5.1 (ts3.6) — 2021-07-08
- 4.5.0 (ts3.4) — 2021-02-22
- 2.0.1 (ts2.2) — 2019-02-13
- 4.5.2 — 2023-10-18
- 2.0.0 — 2018-07-14

## README

# Installation
> `npm install --save @types/keen-tracking`

# Summary
This package contains type definitions for keen-tracking (https://github.com/keen/keen-tracking.js#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keen-tracking.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keen-tracking/index.d.ts)
````ts
export interface KeenAutoTrackingConfig {
    recordPageViews?: boolean | undefined;
    recordPageViewsOnExit?: boolean | undefined;
    recordScrollState?: boolean | undefined;
    recordClicks?: boolean | undefined;
    recordClicksPositionPointer?: boolean | undefined;
    recordFormSubmits?: boolean | undefined;
    ignoreDisabledFormFields?: boolean | undefined;
    ignoreFormFieldTypes?: string[] | undefined;
    collectIpAddress?: boolean | undefined;
    collectUuid?: boolean | undefined;
    shareUuidAcrossDomains?: boolean | undefined;
    recordElementViews?: boolean | undefined;
}

export interface KeenClient {
    config: {
        projectId: string;
        writeKey: string;
        host: string;
        protocol: string;
        requestType: string;
        resources: {
            base: string;
            version: string;
            projects: string;
            projectId: string;
            events: string;
            queries: string;
        };
    };
    _callbacks: {};
    extensions: {
        events: Array<{}>;
        collections: {};
    };
    queue: {
        capacity: number;
        config: {
            capacity: number;
            interval: number;
        };
        events: {};
        interval: number;
        timer: unknown;
    };
}

export default class KeenTracking {
    constructor(options: { projectId: string; writeKey: string; requestType?: string | undefined });
    recordEvent(collectionName: string, event: object): Promise<{ created: boolean }>;
    recordEvents(events: {
        [collectionName: string]: object[];
    }): Promise<{
        [collectionName: string]: boolean[];
    }>;
    extendEvents(payload: unknown): KeenClient;
    initAutoTracking(config: KeenAutoTrackingConfig): KeenClient;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: none

# Credits
These definitions were written by [Rui Ferreira](https://github.com/rui-ferreira), and [Tudor Tacal](https://github.com/TudorTacal).

---
_Source: https://npm.io/package/@types/keen-tracking · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._