Class Suite

A collection of tests and other suites.

Hierarchy (View Summary)

Node
- Suite

Index

Constructors

Accessors

Methods

Constructors

constructor

new Suite(parent: Suite | null, name: string, fn: (arg0: Suite) => void): Suite
Create a new Suite.
Parameters
- parent: Suite | null
  The suite that contains this suite.
- name: string
  Suite name.
- fn: (arg0: Suite) => void
  The function that populates the suite.
Returns Suite
Overrides Node.constructor
- Defined in runner.js:127

Accessors

fullName

get fullName(): string
Full name of the Node, including the containing suite name.

Returns string
Full name as string.
Inherited from Node.fullName
- Defined in runner.js:38

name

get name(): string
Returns string
Inherited from Node.name
- Defined in runner.js:29

Methods

run

run(reporter: Reporter): Promise<void>
Run the test suite.
Parameters
- reporter: Reporter
  The Reporter to output test status to.
Returns Promise<void>
Overrides Node.run
- Defined in runner.js:193

suite

suite(name: string, fn: (arg0: Suite) => void): void
Add a nested test suite.
Parameters
- name: string
  Test suite name.
- fn: (arg0: Suite) => void
  The function that populates the suite.
Returns void
- Defined in runner.js:174

test

test(name: string, fn: (arg0: Test) => void | Promise<void>): void
Add a test.
Parameters
- name: string
  Test name.
- fn: (arg0: Test) => void | Promise<void>
  The function that implements the test.
Returns void
- Defined in runner.js:154