Aws-sdk-js: Missing Typescript Definition for HttpClient, as well as documentation

Created on 21 Dec 2016  路  4Comments  路  Source: aws/aws-sdk-js

There seems to be a succinct lack of documentation around this very helpful utility class: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/HttpClient.html

I've been trying to use it with my new typescript lambda project to be able to mock the responses for unit testing, but it seems to be missing the definition file as well, giving me a compilation error.

Guess in the meantime I'll just fork my own :/

closed-for-staleness documentation feature-request typings

Most helpful comment

Seeing as how the AWS documentation uses Aws.HttpClient as the example for executing Signed requests (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html#es-request-signing-node) and TypeScript is becoming more and more prevalent, I think this is still a very useful thing to add.

Or, perhaps the documentation should provide a different method of creating a Signed Request v4 for Node -> Elasticsearch and avoid Aws.HttpClient altogether?

All 4 comments

Hi @mboudreau,

I'll look into how much of the HttpClient interface can be effectively documented. The two provided implementations (one for node and one for browsers) differ significantly, and and TS definition would only be able to cover the overlap between the two.

Seeing as how the AWS documentation uses Aws.HttpClient as the example for executing Signed requests (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html#es-request-signing-node) and TypeScript is becoming more and more prevalent, I think this is still a very useful thing to add.

Or, perhaps the documentation should provide a different method of creating a Signed Request v4 for Node -> Elasticsearch and avoid Aws.HttpClient altogether?

A similar issue was reported before (https://github.com/aws/aws-sdk-js/issues/1729). Given the documentation @johndanek linked above hasn't been changed in over a year, can users assume AWS.HttpClient is still the recommended way to access elasticsearch?

Greetings! We鈥檙e closing this issue because it has been open a long time and hasn鈥檛 been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or open a new issue.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ranode picture ranode  路  4Comments

pihish picture pihish  路  4Comments

bhishp picture bhishp  路  4Comments

ataraxus picture ataraxus  路  4Comments

jaggu07 picture jaggu07  路  3Comments