From 4a6d1253e404861ef2488e19aeee9b7a8ea95075 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Thu, 14 Mar 2024 17:20:34 -0700 Subject: [PATCH] add cautionary note --- src/index.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/index.ts b/src/index.ts index 98cd6e7..404d1fb 100644 --- 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