OptionalatOptionalbailBail out on the first failure
OptionalbufferedTrue if this test should be buffered, and only processed once complete.
Defaults to true when t.jobs is set to a value greater than 1.
If set false in that case, then the test will NOT be run in parallel, so this provides a way to control the parallelism within a test suite.
OptionalchildNumeric identifier attached to child tests. Most of the time, this is
set based on the TAP_CHILD_ID environment variable.
OptionalcontextAny arbitrary data that is provided to this test object. Often, this
is set in a t.before() or t.beforeEach() method. Scalar values
are inherited by child tests. Object values are extended in child
tests using Object.create().
If not set in the options, this is initialized to a null-prototyped
object, so that usage like t.context.foo = 'bar' will work as expected.
This is initialized and set on the Test object in the runMain method,
not at construction time. If set explicitly on the Test object in a
before hook, then any context specified on options or inherited from
the parent test will be ignored.
Optionalcwdjust used to calculate the default name from the filename ignored otherwise
OptionaldebugTrue to output LOTS AND LOTS of noisy debugging information.
Set at the top level by the TAP_DEBUG environment variable.
OptionaldiagnosticOptionaldiffOptionaldoOptionalerrorOptionalerrorOptionalexpiredOptionalfailtreat only:true tests as failures, default false
Optionalfailtreat skip tests as failures, default false
Optionalfailtreat todo tests as failures, default false
OptionalfilenameThe file to read, required if tapStream not provided
OptionalfoundOptionalmessageOptionalnameThe name of this test
OptionalomitDo not emit the TAP version 14 line.
OptionalparentParent test of this test
Optionalpassestrack passes in the results lists, default false
OptionalpatternOptionalpreserveDo not elide empty lines and other unnecessary whitespace
OptionalsilentSetting silent:true in a subtest option makes it completely excluded from test output, UNLESS it fails.
This was used historically for a few things which are now implemented with a more sophisticated promise management system, but can be handy in some rare situations.
OptionalskipSkip this test entirely, emitting a # SKIP directive
OptionalsourceOptionalstackThe stack where this test was initiated
OptionalstrictTreat any unknown non-TAP data as an error
May be set at run-time by the TAP stream using pragma +strict
OptionaltapOptionally provide a stream of content to treat as the file's TAP data
OptionaltestOptionaltimeThe amount of time that this test took to complete.
Typically, this is not set explicitly, but inferred from the actual
time spent. However in some cases, it may be reported by the
top-level # time=... comment in a TAP subprocess stream.
OptionaltimeoutAmount of time in milliseconds before this test times out
OptionaltodoMark this test as to be done later, emitting a # TODO directive
OptionaltypeOptionalwanted
Options that may be provided to the @tapjs/core!tap-file.TapFile class