Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Correcting documentation of https-proxy-agent usage for slack-sdk #811

Merged
merged 1 commit into from Jul 22, 2019

Conversation

rajashekar
Copy link
Contributor

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');

TypeError: HttpsProxyAgent is not a constructor
at Object. (/home/rchint1/workspace/Release-Police-mk3/index.js:15:15)
at Module._compile (module.js:643:30)
at Object.Module._extensions..js (module.js:654:10)
at Module.load (module.js:556:32)
at tryModuleLoad (module.js:499:12)
at Function.Module._load (module.js:491:3)
at Function.Module.runMain (module.js:684:10)
at startup (bootstrap_node.js:187:16)
at bootstrap_node.js:608:3

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 [ ])

@CLAassistant
Copy link

CLAassistant commented Jul 12, 2019

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Jul 12, 2019

Codecov Report

Merging #811 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #811   +/-   ##
=======================================
  Coverage   97.85%   97.85%           
=======================================
  Files          15       15           
  Lines         652      652           
  Branches       26       26           
=======================================
  Hits          638      638           
  Misses         13       13           
  Partials        1        1
Flag Coverage Δ
#eventsapi 95.62% <ø> (ø) ⬆️
#interactivemessages 99.18% <ø> (ø) ⬆️
#webapi 98.33% <ø> (ø) ⬆️
#webhook 90.69% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8266961...f245ba4. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Jul 12, 2019

Codecov Report

Merging #811 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #811   +/-   ##
=======================================
  Coverage   97.85%   97.85%           
=======================================
  Files          15       15           
  Lines         652      652           
  Branches       26       26           
=======================================
  Hits          638      638           
  Misses         13       13           
  Partials        1        1
Flag Coverage Δ
#eventsapi 95.62% <ø> (ø) ⬆️
#interactivemessages 99.18% <ø> (ø) ⬆️
#webapi 98.33% <ø> (ø) ⬆️
#webhook 90.69% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8266961...f245ba4. Read the comment docs.

@rajashekar
Copy link
Contributor Author

Note: After raising this PR, I found out that there was another PR - #787 to fix this, but was not merged yet. So keeping this PR open to see if this can be merged once all checks are done.

Copy link
Contributor

@clavin clavin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Nice catch! Thank you for bettering our documentation (and fixing the examples)!

(Failing integration tests related to #834)

@clavin clavin merged commit 1966963 into slackapi:master Jul 22, 2019
@clavin clavin mentioned this pull request Jul 22, 2019
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants