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

Adds a new documentation page about usage in TypeScript projects #644

Merged
merged 2 commits into from
Oct 2, 2018

Conversation

aoberoi
Copy link
Contributor

@aoberoi aoberoi commented Oct 1, 2018

Summary

This page covers the most common questions we've seen when integrating this package into a TypeScript project.

fixes #612
fixes #615

Requirements (place an x in each [ ])

@codecov
Copy link

codecov bot commented Oct 1, 2018

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff           @@
##           master    #644   +/-   ##
======================================
  Coverage    91.9%   91.9%           
======================================
  Files           7       7           
  Lines         482     482           
  Branches       90      90           
======================================
  Hits          443     443           
  Misses         22      22           
  Partials       17      17

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 148c94c...18053d7. Read the comment docs.

Copy link

@RodneyU215 RodneyU215 left a comment

Choose a reason for hiding this comment

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

Looks good! :shipit:

@aoberoi aoberoi merged commit 59f8b7b into slackapi:master Oct 2, 2018
@ronjouch
Copy link

ronjouch commented Oct 2, 2018

@aoberoi @RodneyU215 are you sure about that? microsoft/TypeScript#26220 is still unmerged, and here on my machine with tsc 3.1.1, the correct flag is still esnext.asynciterable; compiling with es2018.asynciterable results into this error:

tsconfig.json:9:23 - error TS6046: Argument for '--lib' option must be: 'es5', 'es6', 'es2015', 'es7', 'es2016', 'es2017', 'es2018', 'esnext', 'dom', 'dom.iterable', 'webworker', 'webworker.importscripts', 'scripthost', 'es2015.core', 'es2015.collection', 'es2015.generator', 'es2015.iterable', 'es2015.promise', 'es2015.proxy', 'es2015.reflect', 'es2015.symbol', 'es2015.symbol.wellknown', 'es2016.array.include', 'es2017.object', 'es2017.sharedmemory', 'es2017.string', 'es2017.intl', 'es2017.typedarrays', 'es2018.intl', 'es2018.promise', 'es2018.regexp', 'esnext.array', 'esnext.symbol', 'esnext.asynciterable', 'esnext.intl'.

9     "lib": ["es2017", "es2018.asynciterable"],
                        ~~~~~~~~~~~~~~~~~~~~~~

node_modules/@slack/client/dist/util.d.ts:32:56 - error TS2304: Cannot find name 'AsyncIterable'.

@aoberoi aoberoi deleted the docs-typescript branch October 2, 2018 17:50
@aoberoi
Copy link
Contributor Author

aoberoi commented Oct 2, 2018

Ah, okay it seems I should have done a little more homework. Thank you @ronjouch for checking my work.

microsoft/TypeScript#26218 was at one point set to milestone TS 3.1 - and so the information here was anticipated to be right, but it looks like the typescript team moved the goal post to TS 3.2. Not a problem, we'll just remove the part about es2018.asynciterable for now and hope we can catch up soon after that change lands.

@RodneyU215
Copy link

@ronjouch My over sight as well; I should have dug deeper. Thanks a lot for the feedback Ronan!

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.

Document lib dependencies in TypeScript compiler options @slack/client incompatible with @types/bluebird@2.x
3 participants