fingerprint-loader/README.md

A simple function that returns FingerprintJS collectFingerprintData without extra setup

# Trackaer

A simple JavaScript package to fetch fingerprint data using FingerprintJS without extra setup. The package automatically loads FingerprintJS and allows you to call `collectFingerprintData()` directly.

## Installation

You can install the package using npm or yarn:

```sh
npm install fingerprint-loader
```

or

```sh
yarn add fingerprint-loader
```

## Usage

### Example in JavaScript / React / Angular

Import and use `collectFingerprintData` like this:

```javascript
import collectFingerprintData from "fingerprint-loader";

async function getData() {
    const data = await collectFingerprintData({ accessKey: "your-access-key", userId: "user-id" });
    console.log("Fingerprint Data:", data);
}

getData();
```

## How It Works
- The package **automatically loads FingerprintJS** on first use.
- Users can **directly call `collectFingerprintData()`** without worrying about script imports.
- Returns **fingerprint data** when called with `accessKey` and `userId`.

## API

### `collectFingerprintData(options: { accessKey: string, userId: string })`
Fetches fingerprint data using FingerprintJS.

#### Parameters:
- `accessKey` (**string**) – Your API access key.
- `userId` (**string**) – Unique user identifier.

#### Returns:
A **Promise** resolving to fingerprint data.

## License
This package is licensed under the MIT License.