https://github.com/typicode/server-ready

Know when a server is ready to receive requests
https://github.com/typicode/server-ready

Last synced: 8 months ago
JSON representation

Know when a server is ready to receive requests

• Host: GitHub
• URL: https://github.com/typicode/server-ready
• Owner: typicode
• License: mit
• Created: 2015-08-05T02:24:45.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-19T21:45:36.000Z (almost 9 years ago)
• Last Synced: 2025-05-03T03:53:24.370Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 20
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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)

> Know when a server is ready to receive requests. Used in [hotel](https://github.com/typicode/hotel).

_See [server-ready-cli](https://github.com/typicode/server-ready-cli) for the command-line tool._

## Install

```

npm install server-ready --save

```

## Example

```javascript

var serverReady = require('server-ready')

var port = 3000

// A server process is spawned here or somewhere else...

serverReady(port, function (err) {

  if (err) return console.error('timeout, can\'t connect to port')

  console.log('port is open or has just opened')

})

```

## How it works?

`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).

## API

__serverReady.timeout__

Default timeout.

__serverReady(port[, host][, timeout], cb)__

Tries to connect to `port`.

## License

MIT - [Typicode :cactus:](https://github.com/typicode)