-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Add explicit types #899
Merged
Merged
Add explicit types #899
Conversation
This file contains 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
These are pulled from the typings I wrote for vscode Fixes xtermjs#898
src/ handles more than that specified (and should incase you're not using TS), this also reduces duplication as the definitions are only in typings/
Ready for review, updated top comment to explain the change more. |
parisk
approved these changes
Aug 20, 2017
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍. Two questions:
- Can we be a bit more lenient with the
bellStyle
option in order to allownull
and convert it internally tonone
? - Should we ditch the
geometry
option (Deprecate geometry option in favor of rows and cols #841)?
|
I allowed null for cursorStyle as well since it's similar to bellStyle. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #898
Fixes #901
Fixes #903
This change brings in manual typings, previous the automatically generated typings via the
declaration
property in tsconfig.json contained everything which is not what we want to expose to consumers. After this goes in,typings/xterm.d.ts
contains the complete API (excluding addons currently).There are also simple tests in
fixtures/typings-test/
that ensure that TS code compiled against the typing files compiles as expected. I found a bug while writing this which is always a good sign that it's useful 😄TODO list:
on
('a' | 'b')on
event listeners https://xtermjs.org/docs/api/terminal/#eventsloadAddon
('a' | 'b')Ensure comments work for functions with overloads (getOption/setOption)Consider adding addon interfaces to the .d.ts(maybe later?)Terminal.scrollDisp
getting removed or renamedClean up and finalize valid optionsRemove dead options from DEFAULT_OPTIONS #897