internal: add emitExperimentalWarning function

codeman869 · gibfahn · commit e6a568b49dcc · 2017-12-20T01:59:34.000Z
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 <michael_dawson@ca.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michaël Zasso <targos@protonmail.com>
diff --git a/lib/internal/util.js b/lib/internal/util.js
@@ -10,6 +10,8 @@ const kArrowMessagePrivateSymbolIndex = binding['arrow_message_private_symbol'];
 const kDecoratedPrivateSymbolIndex = binding['decorated_private_symbol'];
 const noCrypto = !process.versions.openssl;
 
+const experimentalWarnings = new Set();
+
 function isError(e){
 return objectToString(e) === '[object Error]' || e instanceof Error;
 }
@@ -115,6 +117,14 @@ function normalizeEncoding(enc){
 }
 }
 
+function emitExperimentalWarning(feature){
+ if (experimentalWarnings.has(feature)) return;
+ const msg = `${feature} is an experimental feature. This feature could ` +
+ 'change at any time';
+ experimentalWarnings.add(feature);
+ process.emitWarning(msg, 'ExperimentalWarning');
+}
+
 function filterDuplicateStrings(items, low){
 const map = new Map();
 for (var i = 0; i < items.length; i++){
@@ -280,6 +290,7 @@ module.exports ={
 createClassWrapper,
 decorateErrorStack,
 deprecate,
+ emitExperimentalWarning,
 filterDuplicateStrings,
 getConstructorOf,
 isError,

-Original file line number
+Diff line change
 constkDecoratedPrivateSymbolIndex=binding['decorated_private_symbol'];
 constnoCrypto=!process.versions.openssl;
 +constexperimentalWarnings=newSet();
++
 functionisError(e){
 returnobjectToString(e)==='[object Error]'||einstanceofError;
+}
+}
+}
 +functionemitExperimentalWarning(feature){
 +if(experimentalWarnings.has(feature))return;
 +constmsg=`${feature} is an experimental feature. This feature could `+
 +'change at any time';
 +experimentalWarnings.add(feature);
 +process.emitWarning(msg,'ExperimentalWarning');
 +}
++
 functionfilterDuplicateStrings(items,low){
 constmap=newMap();
 for(vari=0;i<items.length;i++){
  createClassWrapper,
  decorateErrorStack,
  deprecate,
 + emitExperimentalWarning,
  filterDuplicateStrings,
  getConstructorOf,
  isError,