Update request type definition and documentation to mention statusMes…

…sage argument to httpHeaders event
aws · Mar 2, 2017 · f266fec · f266fec
1 parent d9edd67
commit f266fec
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/lib/request.d.ts b/lib/request.d.ts
@@ -122,7 +122,7 @@ export class Request<D, E> {
      * @param {string} event - httpHeaders: triggered when headers are sent by the remote server.
      * @param {function} listener - Callback to run when the headers are sent by the remote server.
      */
-    on(event: "httpHeaders", listener: (statusCode: number, headers: {[key: string]: string}, response: Response<D, E>) => void): Request<D, E>;
+    on(event: "httpHeaders", listener: (statusCode: number, headers: {[key: string]: string}, response: Response<D, E>, statusMessage: string) => void): Request<D, E>;
     /**
      * Adds a listener that is triggered when data is sent by the remote server.
      * 
@@ -176,4 +176,4 @@ export class Request<D, E> {
 export interface Progress {
     loaded: number;
     total: number;
-}
+}
diff --git a/lib/request.js b/lib/request.js
@@ -246,11 +246,13 @@ fsm.setupStates();
  *
  * @!group HTTP Events
  *
- * @!event httpHeaders(statusCode, headers, response)
+ * @!event httpHeaders(statusCode, headers, response, statusMessage)
  *   Triggered when headers are sent by the remote server
  *   @param statusCode [Integer] the HTTP response code
  *   @param headers [map<String,String>] the response headers
  *   @param (see AWS.Request~send)
+ *   @param statusMessage [String] A status message corresponding to the HTTP
+ *                                 response code
  *   @context (see AWS.Request~send)
  *
  * @!event httpData(chunk, response)