Skip to content

Commit

Permalink
Merge pull request hapijs#252 from dwelle/patch-2
Browse files Browse the repository at this point in the history
fix client.request API docs
  • Loading branch information
mtharrison authored Sep 6, 2018
2 parents 26911e5 + d2911fa commit 1345862
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,12 +383,14 @@ Sends an endpoint request to the server where:
- `headers` - an object where each key is a request header and the value the header
content. Cannot include an Authorization header. Defaults to no headers.
- `payload` - the request payload sent to the server.
where:
- `err` - the `Error` condition if the request failed.
- `payload` - the server response object.
- `statusCode` - the HTTP response status code.
- `headers` - an object containing the HTTP response headers returned by the server (based on
the server configuration).

Rejects with `Error` if the request failed.

Resolves with object containing:
- `payload` - the server response object.
- `statusCode` - the HTTP response status code.
- `headers` - an object containing the HTTP response headers returned by the server (based on
the server configuration).

### `await client.message(message)`

Expand Down

0 comments on commit 1345862

Please sign in to comment.