feat: add experimental warning

streamich · Nov 7, 2018 · 2828f6a · 2828f6a
1 parent 6ef63d5
commit 2828f6a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/volume.ts b/src/volume.ts
@@ -502,6 +502,8 @@ function validateGid(gid: number) {
 
 // ---------------------------------------- Volume
 
+let promisesWarn = true;
+
 /**
  * `Volume` represents a file system.
  */
@@ -566,6 +568,13 @@ export class Volume {
     private promisesApi = createPromisesApi(this);
 
     get promises() {
+        if (promisesWarn) {
+            promisesWarn = false;
+            require('process').emitWarning(
+                'The fs.promises API is experimental',
+                'ExperimentalWarning',
+            );
+        }
         return this.promisesApi;
     }