Skip to content

Commit

Permalink
docs(README): small grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
JuroUhlar authored Nov 14, 2023
1 parent a59be68 commit 14ef708
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ const visitorData = fpjsClient.init().then(() => {
### 4. Identify visitors

The `getVisitorData` method returns visitor identification data based on the request [options](https://dev.fingerprint.com/docs/js-agent#get-options).
Set `ignoreCache` to `true` to make a request to the API even if the data is present in the cache.
Set `ignoreCache` to `true` to call the API even if the data is present in the cache.

```js
// with async/await
Expand All @@ -140,7 +140,7 @@ See the [JS Agent API reference](https://dev.fingerprint.com/docs/js-agent) for

### Caching

Fingerprint Pro usage is billed per API call. To avoid unnecessarry API calls, it is a good practice cache identification results. The SDK provides three ways to cache visitor data out of the box:
Fingerprint Pro usage is billed per API call. To avoid unnecessary API calls, it is a good practice to cache identification results. The SDK provides three ways to cache visitor data out of the box:

* Session storage (default) - `sessionStorage`
* Local storage - `localStorage`
Expand All @@ -165,8 +165,9 @@ Cache keys are based on the combination of _GetOptions_. For example, API respon
* You can ignore the cached result for a specific API call by passing `{ ignoreCache: true }` to the `getVisitorData()` method.
* You can also use your custom cache implementation as described below.

> [!WARNING]
> If you use data from `extendedResult`, pay additional attention to your caching strategy. Some fields from the extended result (IP address, lastSeenAt, etc.) might change over time for the same visitor. If you need to get the latest results, pass `{ignoreCache: true}` to the `getVisitorData()` function.
> [!NOTE]
> If you use data from [`extendedResult`](https://dev.fingerprint.com/docs/js-agent#extendedresult), pay additional attention to your caching strategy.
> Some fields, for example, `ip` or `lastSeenAt`, might change over time for the same visitor. Use `getVisitorData({ ignoreCache: true })` to fetch the latest identification results.
#### Creating a custom cache

Expand All @@ -191,7 +192,7 @@ Use the `cacheTimeInSeconds` client constructor option to set a custom cache tim

## Support and feedback

To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-spa/issues). If you need private support, you can email us at [[email protected]](mailto:[email protected]).
To report problems, ask questions, or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-spa/issues). If you need private support, you can email us at [[email protected]](mailto:[email protected]).

## Documentation

Expand Down

0 comments on commit 14ef708

Please sign in to comment.