|
80011 | 80011 | "isExported": true |
80012 | 80012 | }, |
80013 | 80013 | "originalName": "src/core/lib/interfaces/bdd.ts", |
| 80014 | + "comment": { |
| 80015 | + "shortText": "This is the BDD interface for registering suites. Typically it will be\naccessed using [[lib/executors/Executor.Executor.getPlugin]], like:", |
| 80016 | + "text": "```js\nconst { describe, it } = intern.getPlugin('interface.bdd');\n```\n\nIt may also be imported as a module, like\n\n```js\nimport { describe, it } from 'intern/lib/interfaces/bdd';\n```\n\nSuites (`describe`) are registered using callback functions, and tests (`it`) can be registered\nwithin the suite callbacks.\n\n```js\ndescribe('foo', () => {\n before(() => { ... });\n afterEach(() => { ... });\n it('should bar', () => { ... });\n it('should baz', () => { ... });\n});\n" |
| 80017 | + }, |
80014 | 80018 | "children": [ |
80015 | 80019 | { |
80016 | 80020 | "id": 4813, |
|
80306 | 80310 | "sources": [ |
80307 | 80311 | { |
80308 | 80312 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80309 | | - "line": 18, |
| 80313 | + "line": 43, |
80310 | 80314 | "character": 10 |
80311 | 80315 | } |
80312 | 80316 | ] |
|
80366 | 80370 | "sources": [ |
80367 | 80371 | { |
80368 | 80372 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80369 | | - "line": 20, |
| 80373 | + "line": 45, |
80370 | 80374 | "character": 4 |
80371 | 80375 | } |
80372 | 80376 | ] |
|
80420 | 80424 | "sources": [ |
80421 | 80425 | { |
80422 | 80426 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80423 | | - "line": 19, |
| 80427 | + "line": 44, |
80424 | 80428 | "character": 11 |
80425 | 80429 | } |
80426 | 80430 | ] |
|
80482 | 80486 | "sources": [ |
80483 | 80487 | { |
80484 | 80488 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80485 | | - "line": 21, |
| 80489 | + "line": 46, |
80486 | 80490 | "character": 5 |
80487 | 80491 | } |
80488 | 80492 | ] |
|
80507 | 80511 | "sources": [ |
80508 | 80512 | { |
80509 | 80513 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80510 | | - "line": 17, |
| 80514 | + "line": 42, |
80511 | 80515 | "character": 29 |
80512 | 80516 | } |
80513 | 80517 | ], |
|
80558 | 80562 | "sources": [ |
80559 | 80563 | { |
80560 | 80564 | "fileName": "src/core/lib/interfaces/bdd.ts", |
80561 | | - "line": 30, |
| 80565 | + "line": 55, |
80562 | 80566 | "character": 28 |
80563 | 80567 | } |
80564 | 80568 | ] |
|
81300 | 81304 | }, |
81301 | 81305 | "originalName": "src/core/lib/interfaces/object.ts", |
81302 | 81306 | "comment": { |
81303 | | - "shortText": "This is the object interface for registering suites. Typically it will be\naccessed using [[lib/executors/Executor.Executor.getInterface]], like:", |
81304 | | - "text": "```js\nconst { registerSuite } = intern.getInterface('object');\n```\n\nIt may also be imported as a module, like\n\n```js\nimport registerSuite from 'intern/lib/interfaces/object';\n```\n\nSuites are described using objects. The object structure is a subset of suite\nproperties, specifically name, the lifecycle methods, and tests.\n\n```js\nregisterSuite('foo', {\n before() {},\n afterEach() {},\n tests: {\n bar() {},\n baz() {}\n }\n});\n```\n\nTests may also describe sub-suites:\n\n```js\nregisterSuite('foo', {\n tests: {\n fooStuff {\n tests: {\n bar() {},\n baz() {}\n }\n }\n }\n});\n```\n\nSub-suites don't need name properties, and may also omit the 'tests' nesting\nif no lifecycle functions are in use. The rule is that if a 'tests' property\nisn't in the sub-suite object, then every property is assumed to refer to a\ntest.\n\n```js\nregisterSuite('foo', {\n fooStuff {\n bar() {},\n baz() {}\n }\n});\n```\n" |
| 81307 | + "shortText": "This is the object interface for registering suites. Typically it will be\naccessed using [[lib/executors/Executor.Executor.getPlugin]], like:", |
| 81308 | + "text": "```js\nconst { registerSuite } = intern.getPlugin('interface.object');\n```\n\nIt may also be imported as a module, like\n\n```js\nimport registerSuite from 'intern/lib/interfaces/object';\n```\n\nSuites are described using objects. The object structure is a subset of suite\nproperties, specifically name, the lifecycle methods, and tests.\n\n```js\nregisterSuite('foo', {\n before() {},\n afterEach() {},\n tests: {\n bar() {},\n baz() {}\n }\n});\n```\n\nTests may also describe sub-suites:\n\n```js\nregisterSuite('foo', {\n tests: {\n fooStuff {\n tests: {\n bar() {},\n baz() {}\n }\n }\n }\n});\n```\n\nSub-suites don't need name properties, and may also omit the 'tests' nesting\nif no lifecycle functions are in use. The rule is that if a 'tests' property\nisn't in the sub-suite object, then every property is assumed to refer to a\ntest.\n\n```js\nregisterSuite('foo', {\n fooStuff {\n bar() {},\n baz() {}\n }\n});\n```\n" |
81305 | 81309 | }, |
81306 | 81310 | "children": [ |
81307 | 81311 | { |
|
82125 | 82129 | }, |
82126 | 82130 | "originalName": "src/core/lib/interfaces/tdd.ts", |
82127 | 82131 | "comment": { |
82128 | | - "shortText": "This is the TDD interface for registering suites. Typically it will be\naccessed using [[lib/executors/Executor.Executor.getInterface]], like:", |
82129 | | - "text": "```js\nconst { suite, test } = intern.getInterface('tdd');\n```\n\nIt may also be imported as a module, like\n\n```js\nimport { suite, test } from 'intern/lib/interfaces/tdd';\n```\n\nSuites are registered using callback functions, and tests can be registered\nwithin the suite callbacks.\n\n```js\nsuite('foo', () => {\n before(() => { ... });\n afterEach(() => { ... });\n test('bar', () => { ... });\n test('baz', () => { ... });\n});\n" |
| 82132 | + "shortText": "This is the TDD interface for registering suites. Typically it will be\naccessed using [[lib/executors/Executor.Executor.getPlugin]], like:", |
| 82133 | + "text": "```js\nconst { suite, test } = intern.getPlugin('interface.tdd');\n```\n\nIt may also be imported as a module, like\n\n```js\nimport { suite, test } from 'intern/lib/interfaces/tdd';\n```\n\nSuites are registered using callback functions, and tests can be registered\nwithin the suite callbacks.\n\n```js\nsuite('foo', () => {\n before(() => { ... });\n afterEach(() => { ... });\n test('bar', () => { ... });\n test('baz', () => { ... });\n});\n" |
82130 | 82134 | }, |
82131 | 82135 | "children": [ |
82132 | 82136 | { |
|
0 commit comments