All files / src useFingerprint.ts

0% Statements 0/4

0% Branches 0/2

0% Functions 0/1

0% Lines 0/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30  
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  import { useContext } from 'react'
import { FingerprintContext } from './FingerprintContext'
import type { FingerprintClient } from './types'
import { FingerprintContextNotAvailableError } from './errors'
 
/**
 * Returns the {@link FingerprintClient} from the nearest {@link FingerprintProvider}.
 *
 * Use this when you need the imperative client from inside the React tree (e.g. in an event handler
 * or effect) but do not want the query-state management of {@link useVisitorData}.
 *
 * @group Hooks approach
 *
 * @example
 * ```ts
 * const fp = useFingerprint()
 *
 * useEffect(() => {
 *   fp.get({ linkedId: 'user_1234' }).then(setResult)
 * }, [fp])
 * ```
 */
export function useFingerprint(): FingerprintClient {
  const { client } = useContext(FingerprintContext)
  if (!client) {
    throw new FingerprintContextNotAvailableError()
  }
  return client
}