API Reference

HighWire(options?)

Creates an instance. Available as the window.HighWire global (UMD) or as a named/default export (ESM).

function HighWire(options?: HighWireOptions): HighWireInstance;

collect(options?)

Gathers device, page, fingerprint, paste, and geolocation signals and packs them into a blob.

collect(options?: CollectOptions): Promise<CollectResult>;

const { blob, payload } = await hw.collect({
  geolocation: { enabled: false },
});

CollectOptions

CollectResult

collect() is fail-safe: individual signal failures (geolocation denied, fingerprinting blocked) still produce a blob.

observeField(element, fieldName)

Marks a field for paste detection. The tracker listens only for the paste event and records the fieldName you pass — it never reads the field's value.

observeField(element: Element, fieldName: string): Unobserve;

Returns an Unobserve function (() => void) that removes the listener — call it when the field unmounts. Pasted field names show up in the payload's pastedFields array.

Payload types

CollectedPayload — the decoded blob:

DeviceSignals — user agent, language(s), platform, vendor, hardware concurrency, device memory, screen and window dimensions, color depth, pixel ratio, timezone and UTC offset. Most fields are nullable — absent signals are recorded as null, never guessed.

PageSignals — referrer, origin, pathname, search, title, page-load and collection timestamps, first-seen timestamp (persisted in localStorage), time on page, and time on site (all times in milliseconds).

FingerprintResult

GeolocationResult — a union discriminated by source:

Helpers and constants

function packBlob(payload: CollectedPayload): string;
function unpackBlob(blob: string): CollectedPayload;

class HighWireError extends Error {
  readonly code: string; // 'invalid_blob'
  name: 'HighWireError';
}

const HIGHWIRE_JS_VERSION = '0.1.0';
const BLOB_SCHEMA_VERSION = 1;

unpackBlob throws a HighWireError with code 'invalid_blob' when given a malformed blob — useful if you want to inspect a blob while debugging. This is the only error the library throws.