Skip to main content

Installation

Install​

pnpm add @rtorcato/browser-common
# or
npm install @rtorcato/browser-common
# or
yarn add @rtorcato/browser-common

The package is ESM-only. Your project's tsconfig.json should have "module": "esnext" (or "nodenext") and your package.json should have "type": "module".

Requirements​

  • Browser: any modern evergreen browser (Chrome, Firefox, Safari, Edge) for most modules. A few are Chromium-only — see the browser support guide.
  • Node.js: ≥22 for local development. The published package targets ES2022 + DOM and runs in any modern browser.
  • Bundler: Vite, Webpack 5+, Rollup, esbuild — anything that respects package.json "exports" and "sideEffects": false will tree-shake correctly.

Import the module you need​

Always use subpath imports. Never import from the root.

// ✅ Tree-shakes to just clipboard bytes
import { isClipboardApiAvailable, copyToClipboard } from '@rtorcato/browser-common/clipboard'

// ❌ Don't do this — root exports nothing
import * as browserCommon from '@rtorcato/browser-common'

Your first call​

Every module ships a support-check function — call it before any operation:

import { isClipboardApiAvailable, copyToClipboard } from '@rtorcato/browser-common/clipboard'

async function copy(text: string) {
	if (!isClipboardApiAvailable()) {
		console.warn('Clipboard API not available in this environment')
		return false
	}
	return await copyToClipboard(text)
}

See the contract guide for the full safety guarantees, or browse the API Reference for all 44 modules.