{"id":15659913,"url":"https://github.com/typicode/server-ready","last_synced_at":"2025-05-04T04:27:16.648Z","repository":{"id":35931799,"uuid":"40219990","full_name":"typicode/server-ready","owner":"typicode","description":"Know when a server is ready to receive requests","archived":false,"fork":false,"pushed_at":"2017-01-19T21:45:36.000Z","size":8,"stargazers_count":20,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-03T03:53:24.370Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/typicode.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":"2015-08-05T02:24:45.000Z","updated_at":"2024-06-14T06:09:30.000Z","dependencies_parsed_at":"2022-09-18T01:55:44.544Z","dependency_job_id":null,"html_url":"https://github.com/typicode/server-ready","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typicode%2Fserver-ready","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typicode%2Fserver-ready/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typicode%2Fserver-ready/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typicode%2Fserver-ready/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typicode","download_url":"https://codeload.github.com/typicode/server-ready/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252140979,"owners_count":21700773,"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-03T13:19:34.342Z","updated_at":"2025-05-03T03:53:28.123Z","avatar_url":"https://github.com/typicode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# server-ready [![Build Status](https://travis-ci.org/typicode/server-ready.svg)](https://travis-ci.org/typicode/server-ready) [![npm version](https://badge.fury.io/js/server-ready.svg)](https://www.npmjs.com/package/server-ready)\n\n\u003e Know when a server is ready to receive requests. Used in [hotel](https://github.com/typicode/hotel).\n\n_See [server-ready-cli](https://github.com/typicode/server-ready-cli) for the command-line tool._\n\n## Install\n\n```\nnpm install server-ready --save\n```\n\n## Example\n\n```javascript\nvar serverReady = require('server-ready')\nvar port = 3000\n\n// A server process is spawned here or somewhere else...\nserverReady(port, function (err) {\n  if (err) return console.error('timeout, can\\'t connect to port')\n  console.log('port is open or has just opened')\n})\n```\n\n## How it works?\n\n`server-ready` will try to connect every `250ms` to the specified `port` until a connection has been made or timeout has been reached (`20s` by default).\n\n## API\n\n__serverReady.timeout__\n\nDefault timeout.\n\n__serverReady(port[, host][, timeout], cb)__\n\nTries to connect to `port`.\n\n## License\n\nMIT - [Typicode :cactus:](https://github.com/typicode)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypicode%2Fserver-ready","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypicode%2Fserver-ready","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypicode%2Fserver-ready/lists"}