consider printing Experimental warnings for all Experimental APIs #9036
Comments
Fishrock123
added
the
meta
|
Definitely worth considering. Can be done in a reasonably painless and consistent way via a new internal/util method like |
This adds process.emitExperimentalWarning() which can used to communicate to our users that a feature they are using is experimental and can be changed/removed at any time. Ref: nodejs#9036
This is currently an experimental feature, so we should make sure users are aware that it can be changed at any time. Ref: nodejs#9036
|
Anyone want to pick this up? If not, anyone willing to mentor someone willing to do it? If so, let's add the |
Trott
added
the
help wanted
|
@Trott @Fishrock123 I would like to pick this one up. But where is it at? Shall I just pick up from where #9042 left off and fix the outstanding issues on that PR (which may lead to more refactoring once I get an understanding of how it should work)? |
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. Refs: nodejs#9036
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. PR-URL: #16497 Refs: #9036 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. PR-URL: #16497 Refs: #9036 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. PR-URL: #16497 Refs: #9036 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. PR-URL: #16497 Refs: #9036 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Adds a new emitExperimentalWarning function to internal/util to warn users that they are using an experimental feature and that feature can change at any time. PR-URL: #16497 Refs: #9036 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
|
We do have a function now which was added in #16497 but it's currently not being used in lib (but at least it has tests). Perhaps a good follow-up would be to figure out how to make the rest of the code use it and extend it as necessary to make that happen? |
|
It seems like perhaps this should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. (Or, perhaps better, open a PR.) I'm just tidying up and not acting on a super-strong opinion or anything like that. |
Thought of this in #7448 (comment)
Maybe we should codify to always print warnings on access/use of Experimental features? Imo makes it more clear to anyone running the code that it may change / be removed / etc etc.
cc @jasnell
The text was updated successfully, but these errors were encountered: