Class FpjsClient

constructor

• new FpjsClient(options?): FpjsClient

• Parameters

  • Optional options: FpjsSpaOptions

  Returns FpjsClient

Optional Readonly cacheLocation

clearCache

• clearCache(): Promise<void>

• Clears visitor data from cache regardless of the cache implementation

  Returns Promise<void>

getVisitorData

• getVisitorData<TExtended>(options?, ignoreCache?): Promise<FpjsSpaResponse<VisitorData<TExtended>>>

• Returns visitor identification data based on the request options [https://dev.fingerprint.com/docs/js-agent#visitor-identification]

  Type Parameters

  • TExtended extends boolean

  Parameters

  • options: FingerprintJSPro.GetOptions<TExtended, unknown> = {}
  • ignoreCache: boolean = false

    if set to true a request to the API will be made even if the data is present in cache

  Returns Promise<FpjsSpaResponse<VisitorData<TExtended>>>

getVisitorDataFromCache

• getVisitorDataFromCache<TExtended>(options?): Promise<undefined | FpjsSpaResponse<VisitorData<TExtended>>>

• Returns cached visitor data based on the request options, or undefined if the data is not present in cache

  Type Parameters

  • TExtended extends boolean

  Parameters

  • options: FingerprintJSPro.GetOptions<TExtended, unknown> = {}

  Returns Promise<undefined | FpjsSpaResponse<VisitorData<TExtended>>>

init

• init(passedLoadOptions?): Promise<FingerprintJSPro.Agent>

• Loads FPJS JS agent with certain settings and stores the instance in memory [https://dev.fingerprint.com/docs/js-agent#agent-initialization]

  Parameters

  • Optional passedLoadOptions: Partial<FingerprintJSPro.LoadOptions>

    Additional load options to be passed to the agent, they will be merged with load options provided in the constructor.

  Returns Promise<FingerprintJSPro.Agent>

isInCache

• isInCache(options?): Promise<boolean>

• Checks if request matching given options is present in cache

  Parameters

  • options: FingerprintJSPro.GetOptions<boolean, unknown> = {}

  Returns Promise<boolean>

Static makeCacheKey

• makeCacheKey<TExtended>(options): CacheKey<TExtended>

• Makes a CacheKey object from GetOptions

  Type Parameters

  • TExtended extends boolean

  Parameters

  • options: FingerprintJSPro.GetOptions<TExtended, unknown>

  Returns CacheKey<TExtended>