Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Runner

Initialize a Runner for the given suite.

see

https://mochajs.org/api/Mocha.Runner.html

Hierarchy

Index

Constructors

constructor

  • Parameters

    • suite: Suite
    • delay: boolean

    Returns Runner

  • deprecated

    Use the overload that accepts Mocha.Suite instead.

    Parameters

    • suite: ISuite
    • delay: boolean

    Returns Runner

Properties

Optional allowUncaught

allowUncaught: undefined | false | true

Optional asyncOnly

asyncOnly: undefined | false | true

Optional currentRunnable

currentRunnable: Runnable

failures

failures: number

Optional forbidOnly

forbidOnly: undefined | false | true

Optional forbidPending

forbidPending: undefined | false | true

Optional fullStackTrace

fullStackTrace: undefined | false | true

Optional ignoreLeaks

ignoreLeaks: undefined | false | true

started

started: boolean

Optional stats

stats: Stats

suite

suite: Suite

Optional test

test: Test

total

total: number

Methods

abort

  • abort(): this

addListener

  • addListener(event: "waiting", listener: function): this
  • addListener(event: "start", listener: function): this
  • addListener(event: "end", listener: function): this
  • addListener(event: "suite", listener: function): this
  • addListener(event: "suite end", listener: function): this
  • addListener(event: "test", listener: function): this
  • addListener(event: "test end", listener: function): this
  • addListener(event: "hook", listener: function): this
  • addListener(event: "hook end", listener: function): this
  • addListener(event: "pass", listener: function): this
  • addListener(event: "fail", listener: function): this
  • addListener(event: "pending", listener: function): this
  • addListener(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected checkGlobals

  • checkGlobals(test: Test): void

emit

  • emit(name: "waiting", rootSuite: Suite): boolean
  • emit(name: "start"): boolean
  • emit(name: "end"): boolean
  • emit(name: "suite", suite: Suite): boolean
  • emit(name: "suite end", suite: Suite): boolean
  • emit(name: "test", test: Test): boolean
  • emit(name: "test end", test: Test): boolean
  • emit(name: "hook", hook: Hook): boolean
  • emit(name: "hook end", hook: Hook): boolean
  • emit(name: "pass", test: Test): boolean
  • emit(name: "fail", test: Test, err: any): boolean
  • emit(name: "pending", test: Test): boolean
  • emit(name: string, ...args: any[]): boolean
  • Parameters

    • name: "waiting"
    • rootSuite: Suite

    Returns boolean

  • Parameters

    • name: "start"

    Returns boolean

  • Parameters

    • name: "end"

    Returns boolean

  • Parameters

    • name: "suite"
    • suite: Suite

    Returns boolean

  • Parameters

    • name: "suite end"
    • suite: Suite

    Returns boolean

  • Parameters

    • name: "test"
    • test: Test

    Returns boolean

  • Parameters

    • name: "test end"
    • test: Test

    Returns boolean

  • Parameters

    • name: "hook"
    • hook: Hook

    Returns boolean

  • Parameters

    • name: "hook end"
    • hook: Hook

    Returns boolean

  • Parameters

    • name: "pass"
    • test: Test

    Returns boolean

  • Parameters

    • name: "fail"
    • test: Test
    • err: any

    Returns boolean

  • Parameters

    • name: "pending"
    • test: Test

    Returns boolean

  • Parameters

    • name: string
    • Rest ...args: any[]

    Returns boolean

Protected fail

  • fail(test: Test, err: any): void

Protected failHook

  • failHook(hook: Hook, err: any): void
  • Fail the given hook with err.

    Hook failures work in the following pattern:

    • If bail, then exit
    • Failed before hook skips all tests in a suite and subsuites, but jumps to corresponding after hook
    • Failed before each hook skips remaining tests in a suite and jumps to corresponding after each hook, which is run only once
    • Failed after hook does not alter execution order
    • Failed after each hook skips remaining tests in a suite and subsuites, but executes other after each hooks
    see

    https://mochajs.org/api/Mocha.Runner.html#failHook

    Parameters

    • hook: Hook
    • err: any

    Returns void

Protected globalProps

  • globalProps(): string[]

globals

  • globals(): string[]
  • globals(arr: ReadonlyArray<string>): this

grep

  • grep(re: RegExp, invert: boolean): this

grepTotal

  • grepTotal(suite: Suite): number
  • grepTotal(suite: ISuite): number
  • Returns the number of tests matching the grep search for the given suite.

    see

    https://mochajs.org/api/Mocha.Runner.html#.Runner#grepTotal

    Parameters

    Returns number

  • deprecated

    Use the overload that accepts Mocha.Suite instead.

    Parameters

    Returns number

Protected hook

  • hook(name: string, fn: function): void

Protected hookDown

  • hookDown(name: string, fn: function): void

Protected hookUp

  • hookUp(name: string, fn: function): void
  • Run hooks from the top level down.

    see

    https://mochajs.org/api/Mocha.Runner.html#hookUp

    Parameters

    • name: string
    • fn: function
        • (err?: any, errSuite?: Suite): void
        • Parameters

          • Optional err: any
          • Optional errSuite: Suite

          Returns void

    Returns void

Protected hooks

  • hooks(name: string, suites: Suite[], fn: function): void
  • Run hook name for the given array of suites in order, and callback fn(err, errSuite).

    see

    https://mochajs.org/api/Mocha.Runner.html#hooks

    Parameters

    • name: string
    • suites: Suite[]
    • fn: function
        • (err?: any, errSuite?: Suite): void
        • Parameters

          • Optional err: any
          • Optional errSuite: Suite

          Returns void

    Returns void

on

  • on(event: "waiting", listener: function): this
  • on(event: "start", listener: function): this
  • on(event: "end", listener: function): this
  • on(event: "suite", listener: function): this
  • on(event: "suite end", listener: function): this
  • on(event: "test", listener: function): this
  • on(event: "test end", listener: function): this
  • on(event: "hook", listener: function): this
  • on(event: "hook end", listener: function): this
  • on(event: "pass", listener: function): this
  • on(event: "fail", listener: function): this
  • on(event: "pending", listener: function): this
  • on(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: "waiting", listener: function): this
  • once(event: "start", listener: function): this
  • once(event: "end", listener: function): this
  • once(event: "suite", listener: function): this
  • once(event: "suite end", listener: function): this
  • once(event: "test", listener: function): this
  • once(event: "test end", listener: function): this
  • once(event: "hook", listener: function): this
  • once(event: "hook end", listener: function): this
  • once(event: "pass", listener: function): this
  • once(event: "fail", listener: function): this
  • once(event: "pending", listener: function): this
  • once(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Protected parents

prependListener

  • prependListener(event: "waiting", listener: function): this
  • prependListener(event: "start", listener: function): this
  • prependListener(event: "end", listener: function): this
  • prependListener(event: "suite", listener: function): this
  • prependListener(event: "suite end", listener: function): this
  • prependListener(event: "test", listener: function): this
  • prependListener(event: "test end", listener: function): this
  • prependListener(event: "hook", listener: function): this
  • prependListener(event: "hook end", listener: function): this
  • prependListener(event: "pass", listener: function): this
  • prependListener(event: "fail", listener: function): this
  • prependListener(event: "pending", listener: function): this
  • prependListener(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "waiting", listener: function): this
  • prependOnceListener(event: "start", listener: function): this
  • prependOnceListener(event: "end", listener: function): this
  • prependOnceListener(event: "suite", listener: function): this
  • prependOnceListener(event: "suite end", listener: function): this
  • prependOnceListener(event: "test", listener: function): this
  • prependOnceListener(event: "test end", listener: function): this
  • prependOnceListener(event: "hook", listener: function): this
  • prependOnceListener(event: "hook end", listener: function): this
  • prependOnceListener(event: "pass", listener: function): this
  • prependOnceListener(event: "fail", listener: function): this
  • prependOnceListener(event: "pending", listener: function): this
  • prependOnceListener(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeListener

  • removeListener(event: "waiting", listener: function): this
  • removeListener(event: "start", listener: function): this
  • removeListener(event: "end", listener: function): this
  • removeListener(event: "suite", listener: function): this
  • removeListener(event: "suite end", listener: function): this
  • removeListener(event: "test", listener: function): this
  • removeListener(event: "test end", listener: function): this
  • removeListener(event: "hook", listener: function): this
  • removeListener(event: "hook end", listener: function): this
  • removeListener(event: "pass", listener: function): this
  • removeListener(event: "fail", listener: function): this
  • removeListener(event: "pending", listener: function): this
  • removeListener(event: string, listener: function): this
  • Parameters

    • event: "waiting"
    • listener: function
        • (rootSuite: Suite): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "start"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "suite"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "suite end"
    • listener: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "test end"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "hook end"
    • listener: function
        • (hook: Hook): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "pass"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "fail"
    • listener: function
        • (test: Test, err: any): void
        • Parameters

          • test: Test
          • err: any

          Returns void

    Returns this

  • Parameters

    • event: "pending"
    • listener: function
        • (test: Test): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

run

  • run(fn?: undefined | function): this

Protected runSuite

  • runSuite(suite: Suite, fn: function): void

Protected runTest

  • runTest(fn: Done): any

Protected runTests

  • runTests(suite: Suite, fn: function): void

uncaught

  • uncaught(err: any): void

Static Protected immediately

  • immediately(callback: Function): void
  • Wrapper for setImmediate, process.nextTick, or browser polyfill.

    Parameters

    • callback: Function

    Returns void

Generated using TypeDoc