Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface This

Hierarchy

  • Suite
    • This

Constructors

constructor

  • new This(title: string, parentContext?: Context): This
  • Parameters

    • title: string
    • Optional parentContext: Context

    Returns This

Properties

addressSpace

addressSpace: AddressSpace

ctx

ctx: Context

delayed

delayed: boolean

Optional file

file: string

green

green: UAObject

parent

parent: Suite | undefined

pending

pending: boolean

root

root: boolean

setpointNodeNode

setpointNodeNode: UAVariable

source

source: UAObject

suites

suites: Suite[]

tests

tests: Test[]

title

title: string

variableWithAlarm

variableWithAlarm: UAVariable

Static Readonly constants

constants: SuiteConstants

Methods

addListener

  • addListener(event: "beforeAll", listener: function): this
  • Parameters

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

          • hook: Hook

          Returns void

    Returns this

addSuite

  • addSuite(suite: Suite): this

addTest

  • addTest(test: Test): this

afterAll

  • afterAll(fn?: Func): this
  • afterAll(fn?: AsyncFunc): this
  • afterAll(title: string, fn?: Func): this
  • afterAll(title: string, fn?: AsyncFunc): this

afterEach

  • afterEach(fn?: Func): this
  • afterEach(fn?: AsyncFunc): this
  • afterEach(title: string, fn?: Func): this
  • afterEach(title: string, fn?: AsyncFunc): this

bail

  • bail(): boolean
  • bail(bail: boolean): this

beforeAll

  • beforeAll(fn?: Func): this
  • beforeAll(fn?: AsyncFunc): this
  • beforeAll(title: string, fn?: Func): this
  • beforeAll(title: string, fn?: AsyncFunc): this

beforeEach

  • beforeEach(fn?: Func): this
  • beforeEach(fn?: AsyncFunc): this
  • beforeEach(title: string, fn?: Func): this
  • beforeEach(title: string, fn?: AsyncFunc): this

clone

  • clone(): Suite

eachTest

  • eachTest(fn: function): this
  • Iterates through each suite recursively to find all tests. Applies a function in the format fn(test).

    Parameters

    • fn: function
        • (test: Test): void
        • Parameters

          • test: Test

          Returns void

    Returns this

emit

  • emit(name: "beforeAll", hook: Hook): boolean
  • Parameters

    • name: "beforeAll"
    • hook: Hook

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

fullTitle

  • fullTitle(): string

getMaxListeners

  • getMaxListeners(): number

isPending

  • isPending(): boolean

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "beforeAll", listener: function): this
  • Parameters

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

          • hook: Hook

          Returns void

    Returns this

once

  • once(event: "beforeAll", listener: function): this
  • Parameters

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

          • hook: Hook

          Returns void

    Returns this

prependListener

  • prependListener(event: "beforeAll", listener: function): this
  • Parameters

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

          • hook: Hook

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "beforeAll", listener: function): this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: "beforeAll", listener: function): this
  • Parameters

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

          • hook: Hook

          Returns void

    Returns this

retries

  • retries(): number
  • retries(n: string | number): this

run

  • run(): void

setMaxListeners

  • setMaxListeners(n: number): this

slow

  • slow(): number
  • slow(ms: string | number): this

timeout

  • timeout(): number
  • timeout(ms: string | number): this

titlePath

  • titlePath(): string[]

total

  • total(): number

Static create

  • create(parent: Suite, title: string): Suite
  • Create a new Suite with the given title and parent Suite. When a suite with the same title is already present, that suite is returned to provide nicer reporter and more flexible meta-testing.

    Parameters

    • parent: Suite
    • title: string

    Returns Suite

Generated using TypeDoc