{"id":19190938,"url":"https://github.com/andrevarandas/websize","last_synced_at":"2025-09-01T06:40:00.320Z","repository":{"id":259932832,"uuid":"879817755","full_name":"AndreVarandas/websize","owner":"AndreVarandas","description":"⚖️ A library for measuring webpage sizes and render times.","archived":false,"fork":false,"pushed_at":"2024-10-28T22:26:09.000Z","size":157,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-04T07:26:33.594Z","etag":null,"topics":["pagesize","performance","performance-monitoring","web-resources","website","website-analytics"],"latest_commit_sha":null,"homepage":"https://jsr.io/@varandas/websize","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndreVarandas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-28T15:44:28.000Z","updated_at":"2024-10-28T22:26:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"bfc9b8e3-8177-4e4a-af09-a8a25de396e3","html_url":"https://github.com/AndreVarandas/websize","commit_stats":null,"previous_names":["andrevarandas/websize"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Fwebsize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Fwebsize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Fwebsize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndreVarandas%2Fwebsize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndreVarandas","download_url":"https://codeload.github.com/AndreVarandas/websize/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240267659,"owners_count":19774230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pagesize","performance","performance-monitoring","web-resources","website","website-analytics"],"created_at":"2024-11-09T11:38:41.205Z","updated_at":"2025-02-23T04:19:13.493Z","avatar_url":"https://github.com/AndreVarandas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebSize 📏\n\n![Deno](https://img.shields.io/badge/Deno-000000?style=for-the-badge\u0026logo=deno\u0026logoColor=white)\n[![JSR Score](https://jsr.io/badges/@varandas/websize)](https://jsr.io/@varandas/websize)\n[![codecov](https://codecov.io/gh/AndreVarandas/websize/branch/main/graph/badge.svg)](https://codecov.io/gh/AndreVarandas/websize)\n\nA Deno library for measuring webpage sizes and render times. Get accurate\nmeasurements of:\n\n- Raw HTML size\n- Rendered page size (after JavaScript execution)\n- Network transfer size\n- Render time\n\n## Features\n\n- 🚀 Simple static method for quick measurements\n- ⚙️ Configurable options for detailed control\n- 📊 Detailed size metrics and timing\n- 🌐 Supports custom user agents\n- 🔄 Multiple wait conditions for accurate rendering\n- 📝 Optional verbose logging\n\n## Installation\n\n```bash\n# Import from JSR\nimport { WebSize } from \"jsr:@varandas/websize\";\n```\n\n## Quick Start\n\n```typescript\n// Quick single measurement\nconst result = await WebSize.measure(\"https://example.com\");\nconsole.log(result);\n// {\n//   rawSizeKB: 15.2,\n//   renderedSizeKB: 25.7,\n//   renderTimeSeconds: 1.2,\n//   transferSizeMB: 0.35\n// }\n```\n\n## Advanced Usage\n\n### With Custom Options\n\n```typescript\nconst result = await WebSize.measure(\"https://example.com\", {\n  waitUntil: \"networkidle2\", // Wait for network to be idle\n  verbose: true, // Enable detailed logging\n  userAgent: \"Custom Agent\", // Set custom user agent\n});\n```\n\n### Multiple Measurements\n\n```typescript\n// Create a reusable instance\nconst webSize = new WebSize({\n  verbose: true,\n  waitUntil: \"load\",\n});\n\n// Measure multiple sites\nconst sites = [\"https://deno.land\", \"https://example.com\"];\nfor (const site of sites) {\n  const result = await webSize.calculatePageSize(site);\n  console.log(`${site}: ${result.renderedSizeKB}KB`);\n}\n```\n\n## API Reference\n\n### WebSize Class\n\n#### Constructor Options\n\n| Option      | Type        | Default        | Description               |\n| ----------- | ----------- | -------------- | ------------------------- |\n| `userAgent` | `string`    | Chrome/122...  | Browser user agent string |\n| `waitUntil` | `WaitUntil` | `networkidle2` | Page load condition       |\n| `verbose`   | `boolean`   | `false`        | Enable console logging    |\n\n#### Wait Conditions\n\n- `load`: Wait for load event\n- `networkidle0`: No network connections for 500ms\n- `networkidle2`: ≤ 2 network connections for 500ms\n- `none`: Don't wait\n\n### Result Object\n\n```typescript\ninterface PageSizeResult {\n  rawSizeKB: number; // Size of raw HTML\n  renderedSizeKB: number; // Size after JavaScript\n  renderTimeSeconds: number; // Processing time\n  transferSizeMB: number; // Network transfer size\n}\n```\n\n## Development\n\n```bash\n# Run tests\ndeno task test\n\n# Run example\ndeno task example\n\n# Type check\ndeno task check\n```\n\n## Under the Hood\n\nWebSize uses [Astral](https://jsr.io/@astral/astral) as its headless browser\nengine to:\n\n1. Fetch raw HTML content\n2. Execute JavaScript\n3. Measure rendered page size\n4. Track network transfers\n\n## License\n\n[MIT License](LICENSE) - © André Varandas\n\n---\n\nFound a bug? [Open an issue](https://github.com/AndreVarandas/websize/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrevarandas%2Fwebsize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrevarandas%2Fwebsize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrevarandas%2Fwebsize/lists"}