add createProgram docs
#15697
Merged
add createProgram docs
#15697
+13
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This seems like a small (but important) contribution, so no Contribution License Agreement is required at this point. We will now review your pull request. |
mhegazy
reviewed
May 22, 2017
src/compiler/program.ts
Outdated
| @@ -290,6 +290,15 @@ namespace ts { | |||
| return resolutions; | |||
| } | |||
|
|
|||
| /** | |||
| * Parses a set of root files in order, walks their dependency declaration (both imports and triple-slash references) | |||
There was a problem hiding this comment.
how about?
Create a new 'Program' instance. A Program is an immutable collection of 'SourceFiles' and a compilation options that represent a compilation unit.
Creating a program proceeds from a set of rootFiles, expanding the set of inputs by following imports and triple-slash reference directives transitively. `@types` and triple-slash-reference-types are also pulled in.
|
Updated :) |
|
thanks @donaldpipowitch! |
|
Thank you :) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Refers to a little bit to #15693. I try to learn the compiler API and have a "hard" time to find good documentation and resources. I noticed I can't use code completion to see the documentation for certain APIs and I thought it would be a good idea to add them.
I took documentation from https://github.com/Microsoft/TypeScript/wiki/Architectural-Overview, https://github.com/Microsoft/TypeScript/wiki/Using-the-Language-Service-API and https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API to write this comment.
Are you interested in pull requests like that?