[GitHub] [openwhisk-client-js] DrewML commented on a change in pull request #206: Add missing options in main.d.ts Options interface

[GitBox <gi...@apache.org>]

DrewML commented on a change in pull request #206: Add missing options in main.d.ts Options interface
URL: https://github.com/apache/openwhisk-client-js/pull/206#discussion_r390673163
 
 

 ##########
 File path: README.md
 ##########
 @@ -69,7 +69,7 @@ ow.actions.invoke('sample').then(result => console.log(result))
 ```
 
 #### using 3rd party authentication handler
-You can specify an authentication handler in `options.auth_handler` this is an object that provides a function `getAuthHeader` that returns a Promise or String to be used in the `Authorization` http header for every http request.
+You can specify an authentication handler in `options.auth_handler` this is an object that provides a function `getAuthHeader` that returns a Promise resolving to a string to be used in the `Authorization` http header for every http request.
 
 Review comment:
   The code, as written today, will throw if `options.auth_handler` returns a `string`
   
   **Invocation of `auth_handler`**:
   https://github.com/apache/openwhisk-client-js/blob/532236924ef97c00542bca78165312c105525da6/lib/client.js#L209-L216
   
   **Usage of result**:
   https://github.com/apache/openwhisk-client-js/blob/532236924ef97c00542bca78165312c105525da6/lib/client.js#L159
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services