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.

Sign up for GitHub

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

Jump to bottom

Explicitly create type declaration files #898

Closed
Tyriar opened this issue Aug 18, 2017 · 1 comment
Closed

Explicitly create type declaration files #898

Tyriar opened this issue Aug 18, 2017 · 1 comment
Assignees
@Tyriar
Labels
type/bug Something is misbehaving
Milestone
3.0.0

Comments

@Tyriar
Copy link
Member

Tyriar commented Aug 18, 2017

Recently on the v3 branch I turned on "declaration": true. This generates typings for all objects which isn't really what we want. I also notice that it doesn't declare it as a module (declare module "xterm") which might cause problems.

I suggest we handcraft these typings, this will also be a good way of enforcing what is in the public API and what is not.
@Tyriar Tyriar added the type/bug Something is misbehaving label Aug 18, 2017
@Tyriar Tyriar added this to the 3.0.0 milestone Aug 18, 2017
@Tyriar Tyriar self-assigned this Aug 18, 2017
@Tyriar Tyriar changed the title Explicitly create types Explicitly create type declaration files Aug 18, 2017
@Tyriar
Copy link
Member Author

Tyriar commented Aug 18, 2017

The future .d.ts from this PR should be synchronized with the API website https://xtermjs.org/docs/api/terminal/

Tyriar added a commit to Tyriar/xterm.js that referenced this issue Aug 19, 2017
@Tyriar
Use manual typings over automatically generated ones
2f60c24 
These are pulled from the typings I wrote for vscode

Fixes xtermjs#898
This was referenced Aug 19, 2017
Merged
Merged
@Tyriar Tyriar closed this as completed Aug 20, 2017
@Tyriar Tyriar mentioned this issue Oct 27, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Tyriar Tyriar

Labels
type/bug Something is misbehaving
Projects
None yet
Milestone
3.0.0
Development

No branches or pull requests
1 participant
@Tyriar