{"id":22319371,"url":"https://github.com/hiproxy/open-browser","last_synced_at":"2025-07-29T13:31:45.220Z","repository":{"id":57314975,"uuid":"92250552","full_name":"hiproxy/open-browser","owner":"hiproxy","description":"Open browser window and set proxy","archived":false,"fork":false,"pushed_at":"2020-10-13T06:01:02.000Z","size":20,"stargazers_count":12,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-29T07:42:46.430Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/hiproxy.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}},"created_at":"2017-05-24T04:40:56.000Z","updated_at":"2024-01-15T08:29:59.000Z","dependencies_parsed_at":"2022-09-12T15:01:53.945Z","dependency_job_id":null,"html_url":"https://github.com/hiproxy/open-browser","commit_stats":null,"previous_names":["zdying/open-browser"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiproxy%2Fopen-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiproxy%2Fopen-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiproxy%2Fopen-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiproxy%2Fopen-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hiproxy","download_url":"https://codeload.github.com/hiproxy/open-browser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228017953,"owners_count":17856841,"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":[],"created_at":"2024-12-04T00:08:34.452Z","updated_at":"2024-12-04T00:08:35.249Z","avatar_url":"https://github.com/hiproxy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-browser\nOpen browser window and set proxy\n\n# Install\n\n```bash\nnpm install op-browser --save\n```\n\n# Usage\n\n```js\nconst openBrowser = require('op-browser');\n\n// Automatic proxy selection\nopenBrowser.open('chrome', 'https://google.com', 'http://127.0.0.1:8800', '');\n// Proxy auto-configuration (PAC)\nopenBrowser.open('chrome', 'https://google.com', '', 'http://127.0.0.1:8800/proxy.pac');\n```\n\n# API\n\n\u003ca name=\"op-browser\"\u003e\u003c/a\u003e\n\n## op-browser : \u003ccode\u003eobject\u003c/code\u003e\nBrowser\n\n**Kind**: global namespace  \n\n* [op-browser](#op-browser) : \u003ccode\u003eobject\u003c/code\u003e\n    * [.open(browser, url, proxyURL, pacFileURL)](#op-browser.open) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\n    * [.detect(name)](#op-browser.detect) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\n\n\u003ca name=\"op-browser.open\"\u003e\u003c/a\u003e\n\n### op-browser.open(browser, url, proxyURL, pacFileURL, bypassList) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\nopen browser window, if the `pacFileURL` is not empty, will use `proxy auto-configuration`\n\n**Kind**: static method of [\u003ccode\u003eop-browser\u003c/code\u003e](#op-browser)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| browser | \u003ccode\u003eString\u003c/code\u003e | the browser's name |\n| url | \u003ccode\u003eString\u003c/code\u003e | the url that to open |\n| proxyURL | \u003ccode\u003eString\u003c/code\u003e | the proxy url, format: `http://\u003chostname\u003e[:[port]]` |\n| pacFileURL | \u003ccode\u003eString\u003c/code\u003e | the proxy url, format: `http://\u003chostname\u003e[:[port]]/[pac-file-name]` |\n| bypassList | \u003ccode\u003eString\u003c/code\u003e | the list of hosts for whom we bypass proxy settings and use direct connections, See: \"[net/proxy/proxy_bypass_rules.h](https://cs.chromium.org/chromium/src/net/proxy_resolution/proxy_bypass_rules.h?sq=package:chromium\u0026type=cs)\" for the format of these rules |\n\n\u003ca name=\"op-browser.detect\"\u003e\u003c/a\u003e\n\n### op-browser.detect(name) ⇒ \u003ccode\u003ePromise\u003c/code\u003e\ndetect browser, return the browser's path\n\n**Kind**: static method of [\u003ccode\u003eop-browser\u003c/code\u003e](#op-browser)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| name | \u003ccode\u003eString\u003c/code\u003e | the browser name |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiproxy%2Fopen-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiproxy%2Fopen-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiproxy%2Fopen-browser/lists"}