extending.md

Extending FingerprintJS

You can exclude built-in entropy components and add custom entropy components, for example, when a component is too unstable for your needs. Use the built-in hash function to hash your custom list of components.

An example of component exclusion:

// ...

const result = await fp.get()

// The `languages` and `audio` components will be excluded
const { languages, audio, ...components } = result.components

// Optionally, you can make a visitor identifier from your custom list of components
const visitorId = FingerprintJS.hashComponents(components)

An example of component addition:

// ...

const result = await fp.get()

// New components will be added: `foo` and `bar`.
// You should implement the `getFooComponent` and `getBarComponent` functions by yourself,
// they can return any value.
const components = {
  ...result.components,
  foo: { value: await getFooComponent() },
  bar: { value: await getBarComponent() },
}

// Optionally, you can make a visitor identifier from your custom list of components
const visitorId = FingerprintJS.hashComponents(components)

An example of both component exclusion and addition:

// ...

const result = await fp.get()

// The `languages` and `audio` components will be excluded
const { languages, audio, ...components } = result.components

// New components will be added: `foo` and `bar`
const extendedComponents = {
  ...components,
  foo: { value: await getFooComponent() },
  bar: { value: await getBarComponent() },
}

// Optionally, you can make a visitor identifier from your custom list of components
const visitorId = FingerprintJS.hashComponents(extendedComponents)

You can format your custom list of components into a human-friendly text:

// ...

const debugOutput = document.querySelector('pre')
debugOutput.textContent = FingerprintJS.componentsToDebugString(components)

Canvas stabilization

The canvas entropy source consists of 2 images. The first (with a geometry only) is more stable, the second (with a text) gives more entropy. Agent uses both the images by default. If you need more stability, you can exclude the text image. Example:

// ...

let { components } = await fp.get()

if ('value' in components.canvas) {
  components.canvas.value.text = ''
}

// Optionally, you can make a visitor identifier from your custom list of components
const visitorId = FingerprintJS.hashComponents(components)