Type Alias: BrowserContext

type BrowserContext = {
  locale?: string;
  timezone?: string;
  userAgent: string;
  viewport?: {
     height: number;
     width: number;
  };
};

Defined in: types.ts:86

Browser-context fingerprint settings — what "browser" the SDK pretends to be when talking to Snap.

Remarks

userAgent is REQUIRED to make consumers think about UA hygiene up front. If every @snapcap/native consumer defaulted to the same UA, Snap's anti-fraud could detect "this UA + Node TLS fingerprint" as a snapcap consumer. Pass a recent, realistic UA from a real browser; for multi-tenant runners, pass a DIFFERENT UA per client (a JSON tenant-config file is the natural shape — username, password, and browser fingerprint per tenant).

Other fields are optional but recommended for diversity in multi-tenant deployments — match each tenant's locale, viewport, and timezone to whatever real device they'd plausibly be using.

Example

const browser: BrowserContext = {
  userAgent:
    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
  locale: "en-US",
  viewport: { width: 1440, height: 900 },
  timezone: "America/Los_Angeles",
};

See

Credentials

Properties