{"id":47929935,"url":"https://github.com/cnumr/ecoindex_puppeteer","last_synced_at":"2026-04-04T07:14:57.066Z","repository":{"id":174195168,"uuid":"650028207","full_name":"cnumr/ecoindex_puppeteer","owner":"cnumr","description":"Provides puppeteer tools that retrieve ecoindex parameters from a puppeteer page, according to ecoindex definition.","archived":false,"fork":false,"pushed_at":"2023-12-20T13:11:45.000Z","size":605,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"1.x","last_synced_at":"2025-09-10T04:39:27.141Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cnumr.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":"2023-06-06T07:17:52.000Z","updated_at":"2024-12-03T19:52:55.000Z","dependencies_parsed_at":"2024-11-22T10:15:22.628Z","dependency_job_id":null,"html_url":"https://github.com/cnumr/ecoindex_puppeteer","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"a7388e25750933c0d365f9d577da799849591113"},"previous_names":["tsecher/ecoindex_puppeteer"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/cnumr/ecoindex_puppeteer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnumr%2Fecoindex_puppeteer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnumr%2Fecoindex_puppeteer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnumr%2Fecoindex_puppeteer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnumr%2Fecoindex_puppeteer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cnumr","download_url":"https://codeload.github.com/cnumr/ecoindex_puppeteer/tar.gz/refs/heads/1.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnumr%2Fecoindex_puppeteer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31391078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T04:26:24.776Z","status":"ssl_error","status_checked_at":"2026-04-04T04:23:34.147Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-04-04T07:14:55.700Z","updated_at":"2026-04-04T07:14:57.052Z","avatar_url":"https://github.com/cnumr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ecoindex puppeteer\n\nProvides puppeteer tools that retrieve ecoindex parameters from a puppeteer page, according to ecoindex definition.\n\nThis module provides tools that you can use to get EcoIndex parameters with puppeteer.  \nThis module does not get the EcoIndex value. You have to combine it with https://www.npmjs.com/package/ecoindex in order\nto current final EcoIndex score.\n\n## Install\n\nInstall this module as you normally do :  \n`npm install ecoindex_puppeteer`\n\n## How to use ?\n\n### Get page metrics.\n\n#### Introduction\n\nAccording to the EcoIndex definition (https://www.ecoindex.fr/comment-ca-marche/), the metrics used for EcoIndex\ncomputing are kept after this scenario :\n\n- clear browser cache\n- visit a URL\n- scroll to the bottom of the page\n- wait for 3 seconds.\n\nThe module will provide tools that will automate this scenario and the recovery of the 3 needed metrics:\n\n- the number of DOM elements\n- the number of requests\n- the total requests size (in Bytes)\n\nThe module does not initiate a Puppeteer browser session. It is regardless of the puppeteer configuration.\n\n#### Get metrics\n\nYou can get a URL metrics using the method `getPageMetrics(page, url)`.\n\n```nodeJs\nimport {getPageMetrics} from '../src/EcoIndexPage';\n\nconst metrics = await getPageMetrics(page, 'https://www.ecoindex.fr');\n```\n\nYou can also define an object to get scenario events :\n\n```nodeJs\nimport {EcoIndexPage} from '../src/EcoIndexPage';\n\nconst ecoIndexPage = new EcoIndexPage();\n\necoIndexPage.on(null, (eventName, eventData) =\u003e {\n    console.log(`eventName`);\n});\n\nconst metrics = await ecoIndexPage.getMetrics(page, 'https://www.ecoindex.fr');\n```\n\n## Turn page metrics into EcoIndex score\n\nYou can use the `ecoindex` module in order to get ecoindex values from metrics object :\n\n```nodeJs\nimport {getPageMetrics} from '../src/EcoIndexPage';\n\nconst metrics = await getPageMetrics(page, 'https://www.ecoindex.fr');\n\nconst ecoIndexValue = ecoindex.computeEcoIndex(\n    metrics.getDOMElementsCount(), \n    metrics.getRequestsCount(), \n    metrics.getSize()\n);\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnumr%2Fecoindex_puppeteer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcnumr%2Fecoindex_puppeteer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnumr%2Fecoindex_puppeteer/lists"}