Browse Source

Document new port properties

pull/7/head
Luke Childs 7 years ago
parent
commit
6c160183fd
  1. 30
      README.md

30
README.md

@ -124,16 +124,16 @@ You can also easily stop/restart the server. Notice how a new port is used when
```js
const server = await createTestServer();
console.log(server.url);
// 'http://localhost:56711'
console.log(server.port);
// 56711
await server.close();
console.log(server.url);
console.log(server.port);
// undefined
await server.listen();
console.log(server.url);
// 'http://localhost:56804'
console.log(server.port);
// 56804
```
## API
@ -169,6 +169,16 @@ e.g: `'http://localhost:5486'`
`undefined` while the server is not listening.
#### server.port
Type: `number`, `undefined`
The port number you can reach the HTTP server on.
e.g: `5486`
`undefined` while the server is not listening.
#### server.sslUrl
Type: `string`, `undefined`
@ -179,6 +189,16 @@ e.g: `'https://localhost:5487'`
`undefined` while the server is not listening.
#### server.sslPort
Type: `number`, `undefined`
The port number you can reach the HTTPS server on.
e.g: `5487`
`undefined` while the server is not listening.
#### server.caCert
Type: `string`

Loading…
Cancel
Save