Minor: Correcting documentation of https-proxy-agent usage for slack-sdk #811
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Currently in documentation https-proxy-agent module is imported like below
const { HttpsProxyAgent } = require('https-proxy-agent');
Which will cause HttpsProxyAgent come as undefined
which will cause below error on
new HttpsProxyAgent(process.env.http_proxy || 'http://proxyserver:8080');
Refer https proxy agent api doc - https://www.npmjs.com/package/https-proxy-agent
below is the right way to import
const HttpsProxyAgent = require('https-proxy-agent');
Requirements (place an
x
in each[ ]
)