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

Add an option to enable experimental APIs (and throw if it's off) #2826

Closed
Tyriar opened this issue Apr 10, 2020 · 0 comments
Closed

Add an option to enable experimental APIs (and throw if it's off) #2826

Tyriar opened this issue Apr 10, 2020 · 0 comments
Assignees
Labels
area/api breaking-change Breaks API and requires a major version bump type/proposal A proposal that needs some discussion before proceeding
Milestone

Comments

@Tyriar
Copy link
Member

Tyriar commented Apr 10, 2020

Right now we have our experimental APIs in the same dts as the regular APIs and there is no guard to prevent people from using them. I'm proposing we add an option enableProposedApi (aligns with vscode's naming) that would throw an exception when any proposed API is used if that is not explicitly set to true. So anyone trying to use these APIs will get an exception unless they want to opt into proposed APIs which should involve reading the warnings and/or understanding the implications of doing so.

While technically not a breaking change as it would affect experimental APIs only, it would probably cause a lot of issues and it's worth a version bump. I'd feel a lot better about breaking experimental APIs if we had something like this.

@Tyriar Tyriar added type/proposal A proposal that needs some discussion before proceeding breaking-change Breaks API and requires a major version bump area/api labels Apr 10, 2020
@Tyriar Tyriar added this to the 5.0.0 milestone Apr 10, 2020
@Tyriar Tyriar self-assigned this Apr 10, 2020
@Tyriar Tyriar changed the title Add an option to enable experimental APIs (and throw is it's off) Add an option to enable experimental APIs (and throw if it's off) Apr 10, 2020
Tyriar added a commit to Tyriar/xterm.js that referenced this issue May 8, 2020
Tyriar added a commit to Tyriar/xterm.js that referenced this issue Jul 27, 2022
@Tyriar Tyriar closed this as completed Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api breaking-change Breaks API and requires a major version bump type/proposal A proposal that needs some discussion before proceeding
Projects
None yet
Development

No branches or pull requests

1 participant