@wdio/globals 8.16.5 → 8.16.7

package/README.md

@@ -3,7 +3,30 @@ WDIO Globals
 
 > A helper utility for importing global variables directly
 
-This package can be used to import global variables explicitly, e.g.
+In your test files, WebdriverIO puts each of these methods and objects into the global environment. You don't have to import anything to use them. However, if you prefer explicit imports, you can do `import { browser, $, $$, expect } from '@wdio/globals'` and set `injectGlobals: false` in your WDIO configuration.
+
+The following global objects are set if not configured otherwise:
+
+- `browser`: WebdriverIO Browser object
+- `driver`: alias to browser (used when running mobile tests)
+- `multiremotebrowser`: alias to browser or driver but only set for Multiremote sessions
+- `$`: command to fetch an element (see more in API docs)
+- `$$`: command to fetch elements (see more in API docs)
+- `expect`: assertion framework for WebdriverIO (see API docs)
+
+Note: WebdriverIO has no control of used frameworks (e.g. Mocha or Jasmine) setting global variables when bootstrapping their environment.
+
+## Install
+
+To install the package, run:
+
+```sh
+npm i @wdio/globals --save-dev
+```
+
+## Usage
+
+You can implicitly import WebdriverIO primitives as following:
 
 ```ts
 import { browser, $, $$, expect } from '@wdio/globals'
@@ -19,4 +42,16 @@ describe('my test', () => {
 })
 ```
 
+## TypeScript
+
+If you have a TypeScript project you can propagate the WebdriverIO namespace by adding this package to the `types` list, e.g.:
+
+```json title="tsconfig.json"
+{
+    "compilerOptions": {
+        "types": ["node", "@wdio/globals/types"]
+    }
+}
+```
+
 For more information on WebdriverIO Globals, check out the [docs](https://webdriver.io/docs/api/globals).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/globals",
-  "version": "8.16.5",
+  "version": "8.16.7",
   "description": "A helper utility for importing global variables directly",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-globals",
@@ -43,7 +43,7 @@
   },
   "optionalDependencies": {
     "expect-webdriverio": "^4.2.5",
-    "webdriverio": "8.16.5"
+    "webdriverio": "8.16.7"
   },
-  "gitHead": "ca2069d80b7804bd4680850b92a6cd7b4fa4499f"
+  "gitHead": "15f7f225e6a81ea0e5e7a9ba8067ca59007f09c2"
 }