request / request-promise-native

The simplified HTTP request client 'request' with Promise support. Powered by native ES6 promises.
ISC License
1.1k stars 63 forks source link

Documentation does not help the request user #55

Open john-aws opened 5 years ago

john-aws commented 5 years ago

The request package suggests that:

If you'd like request to return a Promise instead, you can use an alternative interface wrapper for request.

It then proceeds to suggest request-promise-native for native Promises.

The problem is that the request-promise-native package's documentation is minimal, and will probably mislead most request users who are simply looking to promisify their code.

Specific examples include:

As it stands, I suspect the casual request user would be better-served by simply using util.promisify. It would be good to write some basic documentation.

ghost commented 4 years ago

... and no mention of how to turn off insanely verbose logging