Node TAP
    Preparing search index...

    Module @tapjs/mocha-globals - v4.0.2

    @tapjs/mocha-globals

    An optional plugin adding Mocha-like BDD and TDD interfaces to the global environment when tap is loaded.

    To install it, run:

    tap plugin add @tapjs/mocha-globals
    

    The goal of this plugin is not to fully implement the Mocha interface with perfect fidelity, but rather to facilitate porting tests to use tap from other test framework dialects, and to provide this interface for those who prefer this style.

    TDD/BDD methods provided:

    • describe(fn) (alias: context(), suite())
    • it(fn) (alias: specify(), test())
    • before(fn) (alias: suiteSetup())
    • after(fn) (alias: suiteTeardown())
    • beforeEach(fn) (alias: setup())
    • afterEach(fn) (alias: teardown())

    Other useful things that are helpful with these:

    Return the tap Test object that corresponds to the current suite or test that the mocha BDD/TDD methods are running.

    The Test corresponding to the current describe() block, or undefined outside of a suite.

    The Test corresponding to the current it() block, or undefined outside of a test.

    The Test corresponding to the "root" where all suites branch off from.

    When the plugin is active, this is always the TAP root test object.

    Set all the BDD/TDD methods in the global space.

    If the --mocha-globals flag is set (true by default) then these methods will be injected into the global space.

    If disabled with --no-mocha-globals on the command line or mocha-globals: false in a .taprc, then you can import them from @tapjs/mocha-globals as named exports.

    Type Aliases

    Done
    HookBlock
    SuiteBlock
    TestBlock

    Variables

    config
    plugin

    Functions

    after
    afterEach
    before
    beforeEach
    currentSuite
    currentTest
    describe
    globalize
    it
    mount
    mounted
    tt

    References

    context → describe
    setup → beforeEach
    specify → it
    suite → describe
    suiteSetup → before
    suiteTeardown → after
    teardown → afterEach
    test → it