@nevware21/tripwire - v0.1.8
    Preparing search index...

    Interface ITestContext

    Test runner context

    0.2.0

    interface ITestContext {
        currentTest?: ITestCase;
        retries: IGetSetChainableFn<ITestContext, number>;
        server?: ITestServer | IPromise<ITestServer>;
        skip(): never;
        slow: IGetSetChainableFn<ITestContext, number>;
        timeout: IGetSetChainableFn<ITestContext, number>;
        type?: ListenerEvent;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Arbitrary properties that can be set on the test context

    Index
    currentTest? retries server? slow timeout type?
    skip
    currentTest?: ITestCase

    Current test

    retries: IGetSetChainableFn<ITestContext, number>

    Gets or sets the number of allowed retries on failed tests. When called without arguments, returns the current retry count. When called with a number, sets the retry count and returns the context for method chaining.

    // Getter usage
    const currentRetries: number = context.retries();
    // Setter usage with chaining
    context.retries(2).timeout(5000);
    server?: ITestServer | IPromise<ITestServer>

    Provides access to the test server instance, if available. This allows tests to interact with the server during execution, such as making HTTP requests to it or checking its status. The server property may be undefined if the test runner does not support a test server, so tests should check for its existence before attempting to use it.

    slow: IGetSetChainableFn<ITestContext, number>

    Gets or sets the threshold for considering a test as slow. When called without arguments, returns the current slow threshold. When called with a millisecond value, sets the threshold and returns the context for method chaining.

    // Getter usage
    const currentSlow: number = context.slow();
    // Setter usage with chaining
    context.slow(1000).timeout(5000);
    timeout: IGetSetChainableFn<ITestContext, number>

    Gets or sets the current test timeout. When called without arguments, returns the current timeout value. When called with a millisecond value, sets the timeout and resets the timer if the test is already running, then returns the context for method chaining.

    // Getter usage
    const currentTimeout: number = context.timeout();
    // Setter usage with chaining
    context.timeout(5000).slow(1000);
    type?: ListenerEvent

    Current listener event type, when applicable

    • Marks the current test as skipped and never returns. This method is intended to be used within test or hook functions to conditionally skip execution.

      Returns never

      it("should skip this test", function() {
          if (someCondition) {
              context.skip();
          }
          // Test code that will be skipped if someCondition is true
      });

    Settings
    Member Visibility

    On This Page
    Properties
    Methods