fix: export StartOptions interface

Author: jlp-craigmorten

README.md

@@ -18,7 +18,7 @@ A11y static analysis tools [only cover 25% of WCAG](https://karlgroves.com/web-a
 
 With Guidepup Virtual Screen Reader you can automate your screen reader unit test workflows the same you as would for mouse or keyboard based scenarios, no sweat!
 
-## Upcoming Features
+## Features
 
 - **Mirrors Real User Experience** - assert on what users really do and hear when using screen readers.
 - **Test Framework Agnostic** - run with Jest, with Playwright, as an independent script, no vendor lock-in.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/virtual-screen-reader",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Virtual screen reader driver for unit test automation.",
   "main": "lib/index.js",
   "author": "Craig Morten <craig.morten@hotmail.co.uk>",

src/Virtual.ts

@@ -20,6 +20,11 @@ import { notImplemented } from "./notImplemented";
 import userEvent from "@testing-library/user-event";
 
 export interface StartOptions extends CommandOptions {
+  /**
+   * The bounding HTML element to use the Virtual Screen Reader in.
+   *
+   * To use the entire page pass `document.body`.
+   */
   container: HTMLElement;
 }
 

src/index.ts

@@ -1,7 +1,7 @@
-import { Virtual } from "./Virtual";
+import { StartOptions, Virtual } from "./Virtual";
 
 export const virtual = new Virtual();
 
 type _Virtual = typeof virtual;
 
-export { _Virtual as Virtual };
+export { StartOptions, _Virtual as Virtual };