@autometa/runner 0.2.48 → 0.2.49

package/dist/index.d.cts

@@ -1,10 +1,11 @@
-import * as _autometa_config from '@autometa/config';
-import * as _autometa_cucumber_expressions from '@autometa/cucumber-expressions';
 import * as _autometa_types from '@autometa/types';
-import * as _autometa_gherkin from '@autometa/gherkin';
-export { DataTable, HTable, MTable, VTable } from '@autometa/gherkin';
 import * as _autometa_scopes from '@autometa/scopes';
+import { FeatureScope, TestTimeout, FeatureAction, ScenarioAction, ScenarioScope, SizedTimeout, RuleAction, RuleScope } from '@autometa/scopes';
 export { Pass, Types } from '@autometa/scopes';
+import * as _autometa_gherkin from '@autometa/gherkin';
+export { DataTable, HTable, MTable, VTable } from '@autometa/gherkin';
+import * as _autometa_config from '@autometa/config';
+import * as _autometa_cucumber_expressions from '@autometa/cucumber-expressions';
 export * from '@autometa/phrases';
 import * as _autometa_app from '@autometa/app';
 export { App, AutometaApp, AutometaWorld, Fixture, World } from '@autometa/app';
@@ -42,126 +43,452 @@ declare const defineConfig: (...args: {
     };
 };
 
+/**
+ * Defines a parameter type for use in step definitions.
+ *
+ * ```ts
+ * import { Color } from '../support/color';
+ *
+ * defineParameterType({
+ *  name: "color",
+ *  regexpPattern: /red|blue|yellow/,
+ *  transform: (value: string) => Color(value)
+ * })
+ *
+ * // using regex arrays
+ * defineParameterType({
+ *  name: "color",
+ *  regexpPattern: [/red/, /blue/, /yellow/],
+ *  transform: (value: string) => Color(value)
+ * })
+ * ```
+ */
 declare const defineParameterType: (...args: _autometa_cucumber_expressions.ParamTypeDefinition[]) => void;
 
-declare const Feature: {
-    (filepath: string): _autometa_scopes.FeatureScope;
-    (filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-    (filepath: string, timeout: _autometa_scopes.TestTimeout): _autometa_scopes.FeatureScope;
-    (testDefinition: _autometa_scopes.FeatureAction, filepath: string): _autometa_scopes.FeatureScope;
-    (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-    (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.FeatureScope;
-    (...args: (string | _autometa_scopes.TestTimeout | _autometa_scopes.FeatureAction)[]): _autometa_scopes.FeatureScope;
-} & {
-    skip: {
-        (filepath: string): _autometa_scopes.FeatureScope;
-        (filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-        (filepath: string, timeout: _autometa_scopes.TestTimeout): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.FeatureScope;
-        (...args: (string | _autometa_scopes.TestTimeout | _autometa_scopes.FeatureAction)[]): _autometa_scopes.FeatureScope;
-    };
-    only: {
-        (filepath: string): _autometa_scopes.FeatureScope;
-        (filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-        (filepath: string, timeout: _autometa_scopes.TestTimeout): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: number): _autometa_scopes.FeatureScope;
-        (testDefinition: _autometa_scopes.FeatureAction, filepath: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.FeatureScope;
-        (...args: (string | _autometa_scopes.TestTimeout | _autometa_scopes.FeatureAction)[]): _autometa_scopes.FeatureScope;
-    };
-};
-declare const Scenario: {
-    (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-    (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-    (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-} & {
-    skip: {
-        (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-    };
-    only: {
-        (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-    };
-};
-declare const ScenarioOutline: {
-    (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-    (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-    (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-} & {
-    skip: {
-        (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-    };
-    only: {
-        (title: string, action: _autometa_scopes.ScenarioAction): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: number): _autometa_scopes.ScenarioScope;
-        (title: string, action: _autometa_scopes.ScenarioAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.ScenarioScope;
-    };
-};
-declare const Rule: {
-    (title: string, action: _autometa_scopes.RuleAction): _autometa_scopes.RuleScope;
-    (title: string, action: _autometa_scopes.RuleAction, timeout: number): _autometa_scopes.RuleScope;
-    (title: string, action: _autometa_scopes.RuleAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.RuleScope;
-} & {
-    skip: {
-        (title: string, action: _autometa_scopes.RuleAction): _autometa_scopes.RuleScope;
-        (title: string, action: _autometa_scopes.RuleAction, timeout: number): _autometa_scopes.RuleScope;
-        (title: string, action: _autometa_scopes.RuleAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.RuleScope;
-    };
-    only: {
-        (title: string, action: _autometa_scopes.RuleAction): _autometa_scopes.RuleScope;
-        (title: string, action: _autometa_scopes.RuleAction, timeout: number): _autometa_scopes.RuleScope;
-        (title: string, action: _autometa_scopes.RuleAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.RuleScope;
-    };
-};
+declare const AppType: (world: _autometa_types.Class<_autometa_app.AutometaWorld>, environment?: string | undefined) => (target: _autometa_types.Class<unknown>) => void;
+
+declare function makeTestEmitter(opts: {
+    groupLogger: boolean;
+}): TestEventEmitter;
+
+/**
+ * Executes a gherkin `.feature` file. Assembles Tests
+ * using the Cucumber file and globally defined Step Definitions.
+ *
+ * ``ts
+ * // using relative path
+ * import { Feature } from '@autometa/runner'
+ *
+ * Feature('../features/my-feature.feature')
+ * ```
+ *
+ * Steps will be automatically assembled from Globally defined Step Definitions,
+ * if a step definition root and app root are defined.
+ *
+ * ```ts
+ * import { defineConfig } from '@autometa/runner'
+ *
+ * defineConfig({
+ *  ...
+ *  roots: {
+ *    steps: ['./test/steps'],
+ *    app: ['./app'],
+ *  },
+ * }
+ * ```
+ *
+ * Global steps are defined in standard Cucumber stle.
+ * ```ts
+ * // ./test/steps/my-steps.ts
+ * import { Given, When, Then } from '@autometa/runner'
+ *
+ * Given('I have a step', () => {})
+ * When('I do something', () => {})
+ * Then('I expect something', () => {})
+ * ```
+ * @param filepath The absolute, relative, or 'feature root' path to the `.feature` file.
+ */
+declare function Feature(filepath: string): FeatureScope;
+/**
+ * Executes a gherkin `.feature` file. Assembles Tests
+ * using the Cucumber file and globally defined Step Definitions.
+ * Accepts a timeout in milliseconds which will be applied to
+ * all tests within the feature.
+ *
+ * ```ts
+ * // using relative path
+ * import { Feature } from '@autometa/runner'
+ *  // 10 second timeout
+ * Feature('../features/my-feature.feature', 10_000)
+ * ```
+ *
+ * Steps will be automatically assembled from Globally defined Step Definitions,
+ * if a step definition root and app root are defined.
+ *
+ * ```ts
+ * import { defineConfig } from '@autometa/runner'
+ *
+ * defineConfig({
+ *  ...
+ *  roots: {
+ *   steps: ['./test/steps'],
+ *   app: ['./app'],
+ *  },
+ * }
+ * ```
+ *
+ * Global steps are defined in standard Cucumber style.
+ *
+ * ```ts
+ * // ./test/steps/my-steps.ts
+ * import { Given, When, Then } from '@autometa/runner'
+ *
+ * Given('I have a step', () => {})
+ * When('I do something', () => {})
+ * Then('I expect something', () => {})
+ * ```
+ * @param filepath The absolute, relative, or 'feature root' path to the `.feature` file.
+ * @param timeout The timeout in milliseconds to apply to all tests within the feature.
+ */
+declare function Feature(filepath: string, timeout: number): FeatureScope;
+/**
+ * Executes a gherkin `.feature` file. Assembles Tests
+ * using the Cucumber file and globally defined Step Definitions.
+ * Accepts a timeout as a `TestTimeout` which is a tuple of `[durationNumber, 'ms' | 's' | 'm' | 'h']`
+ * which will be applied to all tests within the feature.
+ *
+ * i.e. `[10, 's']` is a 10 second timeout. `[1, 'm']` is a 1 minute timeout.
+ *
+ * ```ts
+ * // using relative path
+ * import { Feature } from '@autometa/runner'
+ *
+ * // 10 second timeout
+ * Feature('../features/my-feature.feature', [10, 's'])
+ * ```
+ *
+ * Steps will be automatically assembled from Globally defined Step Definitions,
+ * if a step definition root and app root are defined.
+ *
+ * ```ts
+ * import { defineConfig } from '@autometa/runner'
+ *
+ * defineConfig({
+ *  ...
+ *  roots: {
+ *   steps: ['./test/steps'],
+ *   app: ['./app'],
+ *  },
+ * };
+ *
+ * ```
+ *
+ * @param filepath
+ * @param timeout
+ */
+declare function Feature(filepath: string, timeout: TestTimeout): FeatureScope;
+/**
+ * Executes a gherkin `.feature` file. Assembles Tests
+ * using the Cucumber file and optionally locally defined steps,
+ * mixed with optionally globally defined Step Definitions.
+ *
+ * ```ts
+ * import { Feature } from '@autometa/runner'
+ *
+ * Feature('My Feature', () => {
+ *   Given('I have a step', () => {})
+ *   When('I do something', () => {})
+ *   Then('I expect something', () => {})
+ * })
+ * ```ts
+ *
+ * If defined in the Gherkin, it will also use any Globally defined Step Definitions which match,
+ * if none is defined locally. If a Step Definition is defined both globally and locally,
+ * the most local definition will be used. This applies to sub-scopes like Scenarios and Rules
+ * also.
+ *
+ * ```ts
+ * import { Feature } from '@autometa/runner'
+ *
+ * Feature('My Feature', () => {
+ *  Given('I have a step', () => {})
+ *  When('I do something', () => {})
+ *  Then('I expect something', () => {})
+ *
+ *  Scenario('My Scenario', () => {
+ *    Given('I have a step', () => {})
+ *  })
+ *
+ *  Rule('My Rule', () => {
+ *   Given('I have a step', () => {})
+ *  })
+ *
+ * @param testDefinition
+ * @param filepath
+ */
+declare function Feature(testDefinition: FeatureAction, filepath: string): FeatureScope;
+/**
+ * Executes a gherkin `.feature` file. Assembles Tests
+ * using the Cucumber file and optionally locally defined steps,
+ * mixed with optionally globally defined Step Definitions.
+ * Accepts a timeout in milliseconds which will be applied to
+ * all tests within the feature.
+ *
+ * ```ts
+ * import { Feature } from '@autometa/runner'
+ *
+ * // 10 second timeout
+ * Feature('My Feature', () => {
+ *  Given('I have a step', () => {})
+ *  When('I do something', () => {})
+ *  Then('I expect something', () => {})
+ * }, 10_000)
+ * ```
+ * @param testDefinition the Feature definition callback
+ * @param filepath
+ * @param timeout
+ */
+declare function Feature(testDefinition: FeatureAction, filepath: string, timeout: number): FeatureScope;
+declare function Scenario(title: string, action: ScenarioAction): ScenarioScope;
+declare function Scenario(title: string, action: ScenarioAction, timeout: number): ScenarioScope;
+declare function Scenario(title: string, action: ScenarioAction, timeout: SizedTimeout): ScenarioScope;
+declare function ScenarioOutline(title: string, action: ScenarioAction): ScenarioScope;
+declare function ScenarioOutline(title: string, action: ScenarioAction, timeout: number): ScenarioScope;
+declare function ScenarioOutline(title: string, action: ScenarioAction, timeout: SizedTimeout): ScenarioScope;
+declare function Rule(title: string, action: RuleAction): RuleScope;
+declare function Rule(title: string, action: RuleAction, timeout: number): RuleScope;
+declare function Rule(title: string, action: RuleAction, timeout: SizedTimeout): RuleScope;
+/**
+ * Defines a `Given` step definition. Matches a gherkin step
+ * as either a string literal match, or a Cucumber Expression.
+ *
+ * The callback function is passed as it's last (or only) argument
+ * a copy of the `App` object which also contains a reference to the World.
+ * This can be used to access features, or store data across steps within a test.
+ *
+ * N.b. The App instance is shared between all step definitions and hooks within
+ * the context of a scenario, but cannot be accessed from the same step in a different
+ * scenario.
+ *
+ * ```ts
+ * import { Given } from '@autometa/runner'
+ *
+ * Given('I have a step', (app) => {
+ *  app.world.someData = 'some value'
+ * })
+ * // using destructuring
+ * Given('I have a step', ({ world }) => {
+ *  world.someData = 'some value'
+ * })
+ * ```
+ *
+ * Steps also support Cucumber Expressions, which can be used to match
+ * dynamic values in the step.
+ *
+ * ```ts
+ * import { Given } from '@autometa/runner'
+ *
+ * // matches 'Given I have a step with a 'blue' value'
+ * Given('I have a step with a {string} value', (value, { world }) => {
+ *  world.someData = value
+ * })
+ *
+ * @param pattern The step pattern to match.
+ * @param action The step action to execute.
+ */
 declare const Given: <TText extends string, TTable extends _autometa_gherkin.DataTable = _autometa_gherkin.NeverDataTable>(title: TText, action: _autometa_scopes.StepActionFn<TText, TTable>, tableType?: _autometa_types.Class<TTable> | undefined) => void;
+/**
+ * Defines a `When` step definition. Matches a gherkin step
+ * as either a string literal match, or a Cucumber Expression.
+ *
+ * The callback function is passed as it's last (or only) argument
+ * a copy of the `App` object which also contains a reference to the World.
+ * This can be used to access features, or store data across steps within a test.
+ *
+ * N.b. The App instance is shared between all step definitions and hooks within
+ *
+ * ```ts
+ * import { When } from '@autometa/runner'
+ *
+ * When('I do something', async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * When('I do something', async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * Steps also support Cucumber Expressions, which can be used to match
+ * dynamic values in the step.
+ *
+ * ```ts
+ * import { When } from '@autometa/runner'
+ *
+ * // matches 'When I do something with a 'blue' value'
+ * When('I do something with a {string} value', async (value, { webdriver }) => {
+ *   await webdriver.click(`#some-button-${value}`)
+ * })
+ *
+ * @param pattern The step pattern to match.
+ * @param action The step action to execute.
+ */
 declare const When: <TText_1 extends string, TTable_1 extends _autometa_gherkin.DataTable = _autometa_gherkin.NeverDataTable>(title: TText_1, action: _autometa_scopes.StepActionFn<TText_1, TTable_1>, tableType?: _autometa_types.Class<TTable_1> | undefined) => void;
+/**
+ * Defines a `Then` step definition. Matches a gherkin step
+ * as either a string literal match, or a Cucumber Expression.
+ *
+ * The callback function is passed as it's last (or only) argument
+ * a copy of the `App` object which also contains a reference to the World.
+ * This can be used to access features, or store data across steps within a test.
+ *
+ * N.b. The App instance is shared between all step definitions and hooks within
+ *
+ * ```ts
+ * import { Then } from '@autometa/runner'
+ *
+ * Then('I expect something', async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * Then('I expect something', async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * Steps also support Cucumber Expressions, which can be used to match
+ * dynamic values in the step.
+ *
+ * ```ts
+ * import { Then } from '@autometa/runner'
+ *
+ * // matches 'Then I expect something with a 'blue' value'
+ * Then('I expect something with a {string} value', async (value, { world }) => {
+ *   expect(world.someData).toBe(value)
+ * })
+ *
+ * @param pattern The step pattern to match.
+ * @param action The step action to execute.
+ */
 declare const Then: <TText_2 extends string, TTable_2 extends _autometa_gherkin.DataTable = _autometa_gherkin.NeverDataTable>(title: TText_2, action: _autometa_scopes.StepActionFn<TText_2, TTable_2>, tableType?: _autometa_types.Class<TTable_2> | undefined) => void;
+/**
+ * Defines a `Before` hook. Executes before each scenario.
+ *
+ * ```ts
+ * import { Before } from '@autometa/runner'
+ *
+ * Before(async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * Before(async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * @param action The hook action to execute.
+ */
 declare const Before: {
     (description: string, action: _autometa_scopes.HookAction): _autometa_scopes.BeforeHook;
     (description: string, action: _autometa_scopes.HookAction, timeout: number): _autometa_scopes.BeforeHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string): _autometa_scopes.BeforeHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: number): _autometa_scopes.BeforeHook;
-    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.BeforeHook;
-    (description: string, action: _autometa_scopes.HookAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.BeforeHook;
-    (description: string, action: _autometa_scopes.HookAction, exprOrTimeout?: string | _autometa_scopes.TestTimeout | undefined, timeout?: _autometa_scopes.TestTimeout | undefined): _autometa_scopes.BeforeHook;
+    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: SizedTimeout): _autometa_scopes.BeforeHook;
+    (description: string, action: _autometa_scopes.HookAction, timeout: SizedTimeout): _autometa_scopes.BeforeHook;
+    (description: string, action: _autometa_scopes.HookAction, exprOrTimeout?: string | TestTimeout | undefined, timeout?: TestTimeout | undefined): _autometa_scopes.BeforeHook;
 };
+/**
+ * Defines a `After` hook. Executes after each scenario.
+ *
+ * ```ts
+ * import { After } from '@autometa/runner'
+ *
+ * After(async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * After(async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * @param action The hook action to execute.
+ */
 declare const After: {
     (description: string, action: _autometa_scopes.HookAction): _autometa_scopes.AfterHook;
     (description: string, action: _autometa_scopes.HookAction, timeout: number): _autometa_scopes.AfterHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string): _autometa_scopes.AfterHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: number): _autometa_scopes.AfterHook;
-    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.AfterHook;
-    (description: string, action: _autometa_scopes.HookAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.AfterHook;
-    (description: string, action: _autometa_scopes.HookAction, exprOrTimeout?: string | _autometa_scopes.TestTimeout | undefined, timeout?: _autometa_scopes.TestTimeout | undefined): _autometa_scopes.AfterHook;
+    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: SizedTimeout): _autometa_scopes.AfterHook;
+    (description: string, action: _autometa_scopes.HookAction, timeout: SizedTimeout): _autometa_scopes.AfterHook;
+    (description: string, action: _autometa_scopes.HookAction, exprOrTimeout?: string | TestTimeout | undefined, timeout?: TestTimeout | undefined): _autometa_scopes.AfterHook;
 };
+/**
+ * Defines a `Setup` hook. Executes before all scenarios.
+ * Setups are scoped, meaning a Setup defined inside the scope of a rule
+ * will only apply to scenarios within that rule.
+ *
+ * N.b the Setup Hook and Teardown Hook reference their own unique
+ * copy of the App with it's own unique life cycle. Values stored here
+ * will not be accessible in tests without a singleton fixture.
+ *
+ * ```ts
+ * import { Setup } from '@autometa/runner'
+ *
+ * Setup(async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * Setup(async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * @param action The hook action to execute.
+ */
 declare const Teardown: {
     (description: string, action: _autometa_scopes.HookAction): _autometa_scopes.TeardownHook;
     (description: string, action: _autometa_scopes.HookAction, timeout: number): _autometa_scopes.TeardownHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string): _autometa_scopes.TeardownHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: number): _autometa_scopes.TeardownHook;
-    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.TeardownHook;
-    (description: string, action: _autometa_scopes.HookAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.TeardownHook;
+    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: SizedTimeout): _autometa_scopes.TeardownHook;
+    (description: string, action: _autometa_scopes.HookAction, timeout: SizedTimeout): _autometa_scopes.TeardownHook;
 };
+/**
+ * Defines a `Teardown` hook. Executes after all scenarios have completed.
+ * Teardowns are scoped, meaning a Teardown defined inside the scope of a rule
+ * will only apply to scenarios within that rule.
+ *
+ * N.b the Setup Hook and Teardown Hook reference their own unique
+ * copy of the App with it's own unique life cycle. Values stored here
+ * will not be accessible in tests without a singleston fixture.
+ * ```ts
+ * import { Teardown } from '@autometa/runner'
+ *
+ * Teardown(async (app) => {
+ *   await app.webdriver.click('#some-button')
+ * })
+ *
+ * // using destructuring
+ * Teardown(async ({ webdriver }) => {
+ *  await webdriver.click('#some-button')
+ * })
+ * ```
+ *
+ * @param action The hook action to execute.
+ */
 declare const Setup: {
     (description: string, action: _autometa_scopes.HookAction): _autometa_scopes.SetupHook;
     (description: string, action: _autometa_scopes.HookAction, timeout: number): _autometa_scopes.SetupHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string): _autometa_scopes.SetupHook;
     (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: number): _autometa_scopes.SetupHook;
-    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.SetupHook;
-    (description: string, action: _autometa_scopes.HookAction, timeout: _autometa_scopes.SizedTimeout): _autometa_scopes.SetupHook;
+    (description: string, action: _autometa_scopes.HookAction, tagFilterExpression: string, timeout: SizedTimeout): _autometa_scopes.SetupHook;
+    (description: string, action: _autometa_scopes.HookAction, timeout: SizedTimeout): _autometa_scopes.SetupHook;
 };
 
-declare const AppType: (world: _autometa_types.Class<_autometa_app.AutometaWorld>, environment?: string | undefined) => (target: _autometa_types.Class<unknown>) => void;
-
-declare function makeTestEmitter(opts: {
-    groupLogger: boolean;
-}): TestEventEmitter;
-
 export { After, AppType, Before, Feature, Given, Rule, Scenario, ScenarioOutline, Setup, Teardown, Then, When, defineConfig, defineParameterType, makeTestEmitter };