Interface SupportCodeLibrary

Sealed library of support code that provides hooks and step definitions

interface SupportCodeLibrary {
    findAllAfterHooksBy(
        tags: readonly string[],
    ): readonly DefinedTestCaseHook[];
    findAllBeforeHooksBy(
        tags: readonly string[],
    ): readonly DefinedTestCaseHook[];
    findAllStepsBy(text: string): readonly MatchedStep[];
    getAllAfterAllHooks(): readonly DefinedTestRunHook[];
    getAllBeforeAllHooks(): readonly DefinedTestRunHook[];
    getAllSources(): readonly SourceReference[];
    getExpressionGenerator(): CucumberExpressionGenerator;
    toEnvelopes(): readonly Envelope[];
}

Index

Methods

findAllAfterHooksBy findAllBeforeHooksBy findAllStepsBy getAllAfterAllHooks getAllBeforeAllHooks getAllSources getExpressionGenerator toEnvelopes

Methods

findAllAfterHooksBy

findAllAfterHooksBy(tags: readonly string[]): readonly DefinedTestCaseHook[]
Find all After hooks that match the given tags
Parameters
- tags: readonly string[]
Returns readonly DefinedTestCaseHook[]
Remarks
Hooks are returned in definition order. For execution, the order should be reversed.
- Defined in src/types.ts:355

findAllBeforeHooksBy

findAllBeforeHooksBy(tags: readonly string[]): readonly DefinedTestCaseHook[]
Find all Before hooks that match the given tags
Parameters
- tags: readonly string[]
Returns readonly DefinedTestCaseHook[]
- Defined in src/types.ts:349

findAllStepsBy

findAllStepsBy(text: string): readonly MatchedStep[]
Find all step definitions whose expression is a match for the given text
Parameters
- text: string
Returns readonly MatchedStep[]
- Defined in src/types.ts:359

getAllAfterAllHooks

getAllAfterAllHooks(): readonly DefinedTestRunHook[]
Get all AfterAll hooks

Returns readonly DefinedTestRunHook[]
- Defined in src/types.ts:375

getAllBeforeAllHooks

getAllBeforeAllHooks(): readonly DefinedTestRunHook[]
Get all BeforeAll hooks

Returns readonly DefinedTestRunHook[]
- Defined in src/types.ts:371

getAllSources

getAllSources(): readonly SourceReference[]
Get all source references from across all support code

Returns readonly SourceReference[]
- Defined in src/types.ts:363

getExpressionGenerator

getExpressionGenerator(): CucumberExpressionGenerator
Get a generator for Cucumber Expressions based on the currently defined parameter types

Returns CucumberExpressionGenerator
- Defined in src/types.ts:367

toEnvelopes

toEnvelopes(): readonly Envelope[]
Produces a list of Cucumber Messages envelopes for the support code, with the original definition order retained

Returns readonly Envelope[]
- Defined in src/types.ts:380