{"id":16173236,"url":"https://github.com/joeferner/node-openport","last_synced_at":"2025-03-19T00:30:47.831Z","repository":{"id":2542287,"uuid":"3519902","full_name":"joeferner/node-openport","owner":"joeferner","description":"Looks for an open port to start a server on","archived":false,"fork":false,"pushed_at":"2018-12-08T17:00:51.000Z","size":40,"stargazers_count":12,"open_issues_count":2,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-28T13:23:12.609Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joeferner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-02-22T22:38:21.000Z","updated_at":"2025-02-24T03:47:17.000Z","dependencies_parsed_at":"2022-09-10T01:02:44.045Z","dependency_job_id":null,"html_url":"https://github.com/joeferner/node-openport","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeferner%2Fnode-openport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeferner%2Fnode-openport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeferner%2Fnode-openport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeferner%2Fnode-openport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joeferner","download_url":"https://codeload.github.com/joeferner/node-openport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955805,"owners_count":20374373,"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-10-10T04:07:32.937Z","updated_at":"2025-03-19T00:30:47.576Z","avatar_url":"https://github.com/joeferner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deprecated use [portfinder](https://github.com/indexzero/node-portfinder)\n\n# openport\n\nFinds open network ports.\n\n## Installation\n\n```bash\n$ npm install openport\n```\n\n## Quick Examples\n\n```javascript\nvar op = require('openport'),\n    http = require('http');\n\n// find an open port\nop.find(function(err, port) {\n  if(err) { console.log(err); return; }\n  // yea! we have an open port.\n});\n\n// find two open ports, choosing from 1024, 1025, 1026, 1028\nop.find(\n  {\n    ports: [ 1024, 1025, 1026, 1028 ],\n    count: 2\n  },\n  function(err, ports) {\n    if(err) { console.log(err); return; }\n    // yea! we have two open ports.\n  }\n);\n\n// find an open port between 1024 and 2000, but not 1025 or 1500\nop.find(\n  {\n    startingPort: 1024,\n    endingPort: 2000,\n    avoid: [ 1025, 1500 ]\n  },\n  function(err, port) {\n    if(err) { console.log(err); return; }\n    // yea! we have an open port between 1024 and 2000, but not port 1025 or 1500.\n  }\n);\n\n// create 2 http servers\nop.find(\n  {\n    count: 2,\n    createServer: function (port, callback) {\n      var server = http.createServer(function (req, res) {\n      });\n      server.port = port; // save it for later\n      server.once('error', function (ex) {\n        callback(ex);\n      });\n      server.listen(port, function () {\n        callback(null, server);\n      });\n    }\n  }, function (err, servers) {\n    if(err) { console.log(err); return; }\n    // yea! we have two web servers.\n  }\n);\n```\n\n# API Documentation\n\n### openport.find([options], callback)\n\nFinds open network ports\n\n__Arguments__\n\n * options - (optional) - Find options\n  * startingPort - The port to start searching for an open port (default: 1024).\n  * endingPort - The port to stop searching for an open port (default: 65535).\n  * ports - An array of ports to search.\n  * count - The number of open ports to find.\n  * avoid - An array of ports to avoid.\n  * createServer - A function that will try to open a server listening on the given port. Use this when you want to make sure nobody steals your ports in between calls.\n * callback(err, port/ports/servers) - Callback to be called when we have found the open ports.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeferner%2Fnode-openport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoeferner%2Fnode-openport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeferner%2Fnode-openport/lists"}