Skip to content

Commit ea6dc65

Browse files
committed
Add opts to readme
1 parent 7133ca5 commit ea6dc65

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

readme.markdown

+9-3
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,16 @@ in [node-tap](https://github.com/isaacs/node-tap).
7575
var test = require('tape')
7676
```
7777

78-
## test(name, cb)
78+
## test([name], [opts], cb)
7979

80-
Create a new test with an optional `name` string. `cb(t)` fires with the new
81-
test object `t` once all preceeding tests have finished. Tests execute serially.
80+
Create a new test with an optional `name` string and optional `opts` object.
81+
`cb(t)` fires with the new test object `t` once all preceeding tests have
82+
finished. Tests execute serially.
83+
84+
Available `opts` options are:
85+
- opts.skip = true/false. See test.skip.
86+
- opts.timeout = 500. Set a timeout for the test, after which it will fail.
87+
See test.timeoutAfter.
8288

8389
If you forget to `t.plan()` out how many assertions you are going to run and you
8490
don't call `t.end()` explicitly, your test will hang.

0 commit comments

Comments
 (0)