add cautionary note

saucelabs · Mar 15, 2024 · 4a6d125 · 4a6d125
1 parent 588d073
commit 4a6d125
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,13 @@ import { AuthError, TunnelNameError } from './errors';
 
 let sauceDriver: SauceDriver;
 
+/**
+ * The Sauce Labs browser provider plugin for TestCafe.
+ *
+ * CAUTION: Do not export the `default` keyword, as TestCafe will not be able to
+ * load the plugin. Neither does it support the `exports =` syntax without
+ * `module`.
+ */
 module.exports = {
   /**
    * Inspected by TestCafe to check whether the browser provider supports