test-object-model

test-object-model

test-object-model

• test-object-model
  • Test ⏏
    • new Test([name], [testFn], [options])
    • instance
      • .name : string
      • .testFn : function
      • .index
      • .state
      • .ended
      • .test()
      • .skip()
      • .only()
      • .run() ⇒ Promise
      • .reset()
    • static
      • .combine(tests, [name]) ⇒ Test
    • inner
      • ~TestContext

Test ⏏

Kind: Exported class

new Test([name], [testFn], [options])

Param	Type
[name]	string
[testFn]	function
[options]	object
[options.timeout]	number

test.name : string

Test name

Kind: instance property of Test

test.testFn : function

Test function

Kind: instance property of Test

test.index

Position of this test within its parents children

Kind: instance property of Test

test.state

Test state: pending, start, skip, pass or fail.

Kind: instance property of Test

test.ended

True if ended

Kind: instance property of Test

test.test()

Add a test.

Kind: instance method of Test

test.skip()

Add a skipped test

Kind: instance method of Test

test.only()

Add an only test

Kind: instance method of Test

test.run() ⇒ Promise

Execute the stored test function.

Kind: instance method of Test

test.reset()

Reset state

Kind: instance method of Test

Test.combine(tests, [name]) ⇒ Test

Combine several TOM instances into a common root

Kind: static method of Test

Param	Type
tests	Array.<Test>
[name]	string

Test~TestContext

The test context, available as this within each test function.

Kind: inner class of Test

---

© 2018-19 Lloyd Brookes <[e-mail]>.