Browser Insights

Browser Insights is a lightweight JavaScript library that captures essential client-side information such as browser details, operating system, screen dimensions, network type, and more. This package is ideal for analytics, debugging, or personalizing user experiences.

Features

🖥️ Browser Details: Captures browser name, version, and user agent.
📱 Device & OS Info: Identifies operating system and device type.
🖼️ Screen Details: Provides screen resolution and pixel ratio.
🌐 Network Information: Detects network type (Wi-Fi, 4G, etc.).
🔗 URL & Referrer: Tracks the current page URL and referring page.
🚀 Lightweight and dependency-free.

Installation

To install browser-insights, use npm:

npm install browser-insights

Usage

Import and use browser-insights to capture client-side information:

Example: Capturing All Client Info

const browserInsights = require('browser-insights');

// Capture all available information
const info = browserInsights.getAll();
console.log(info);

/* Example Output:
{
  browser: { name: "Chrome", version: "115", userAgent: "..." },
  os: { name: "Windows", version: "11" },
  screen: { width: 1920, height: 1080, pixelRatio: 2 },
  network: { type: "Wi-Fi" },
  url: { current: "https://example.com", referrer: "https://google.com" }
}
*/

Example: Logging Custom Events

You can also use it to log custom events for debugging or analytics purposes:

browserInsights.logEvent('Button Clicked', { buttonId: 'signup' });

API Documentation

`getAll()`

Returns all available client-side information in a structured format.

`getBrowserInfo()`

Returns detailed browser information:

name: Browser name (e.g., Chrome, Firefox).
version: Browser version.
userAgent: Full user agent string.

`getOSInfo()`

Returns information about the operating system:

name: Operating system name (e.g., Windows, macOS, Linux).
version: OS version (if available).

`getScreenInfo()`

Returns screen-related information:

width: Screen width in pixels.
height: Screen height in pixels.
pixelRatio: Device pixel ratio.

`getNetworkInfo()`

Returns network-related information (if supported by the browser):

type: Network type (e.g., Wi-Fi, 4G).

`getURLInfo()`

Returns the current page's URL and the referrer:

current: Current page URL.
referrer: Referring page URL.