The decorated method.
Decorate a method with @afterEach
to have it run after each it-call in the suite.
The decorated method.
Decorate a method with @beforeAll
to have it run before any it-calls in the suite are executed.
The decorated method.
Decorate a method with @beforeEach
to have it run before each it-call in the suite.
The decorated method.
Call this function in the setup code of your test runner to provide the functions to be called for each suite and each test.
Initialize the configuration with some default values working out of the box for jest an mocha.
Checks that the provided object is compatible with the SuiteOptionsInput
interface.
Anything.
true if the input is compatible and
false` otherwise.
Checks that the provided object is compatible with the TestOptionsInput
interface.
Anything.
true if the input is compatible and
false` otherwise.
Validates and prepares the suite options as handed to the decorator to be able
to operate on them fearlessly inside the @suite
function.
The options as provided by the user.
The validated and prepared options for @suite
.
Validates and prepares the test options as handed to the decorator to be able
to operate on them fearlessly inside the @test
function.
The options as provided by the user.
The validated and prepared options for @test
.
Decorate a class with @suite
or @suite("name of the suite")
or @suite({ ... })to
automatically run the
@test-decorated methods inside a
describe` call.
This automatically creates an instance for the decorated class.
Can be provided or left out, so the decorator can be called with @suite()
or
like @suite
. The name of the suite or a configuration object. @see SuiteOptions
The decorated class.
Decorate a class with @suite
or @suite("name of the suite")
or @suite({ ... })to
automatically run the
@test-decorated methods inside a
describe` call.
This automatically creates an instance for the decorated class.
The decorated class.
Decorate a method with @test
or @test("name of the test")
or @test({ ... })to
automatically have it run as a test inside an
it` call.
The decorated method.
Decorate a method with @test
or @test("name of the test")
or @test({ ... })to
automatically have it run as a test inside an
it` call.
Can be provided or left out, so the decorator can be called with @test()
or
like @test
. The name of the test or a configuration object. @see TestOptions
The decorated method.
Generated using TypeDoc
Decorate a method with
@afterAll
to have it run after any it-calls in the suite are executed.