dots.vscode.test-item
An item shown in the "test explorer" view.
A TestItem can represent either a test suite or a test itself, since
they both have similar capabilities.
An item shown in the "test explorer" view. A `TestItem` can represent either a test suite or a test itself, since they both have similar capabilities.
busy?cljs
(busy? test-item)Controls whether the item is shown as "busy" in the Test Explorer view. This is useful for showing status while discovering children.
Defaults to false.
Returns: boolean
Controls whether the item is shown as "busy" in the Test Explorer view. This is useful for showing status while discovering children. Defaults to `false`. **Returns:** `boolean`
can-resolve-children?cljs
(can-resolve-children? test-item)Indicates whether this test item may have children discovered by resolving.
If true, this item is shown as expandable in the Test Explorer view and expanding the item will cause {@link TestController.resolveHandler } to be invoked with the item.
Default to false.
Returns: boolean
Indicates whether this test item may have children discovered by resolving.
If true, this item is shown as expandable in the Test Explorer view and
expanding the item will cause {@link TestController.resolveHandler }
to be invoked with the item.
Default to `false`.
**Returns:** `boolean`childrencljs
(children test-item)The children of this test item. For a test suite, this may contain the individual test cases or nested suites.
Returns: TestItemCollection
The children of this test item. For a test suite, this may contain the individual test cases or nested suites. **Returns:** `TestItemCollection`
descriptioncljs
(description test-item)Optional description that appears next to the label.
Returns: string | undefined
Optional description that appears next to the label. **Returns:** `string | undefined`
errorcljs
(error test-item)Optional error encountered while loading the test.
Note that this is not a test result and should only be used to represent errors in test discovery, such as syntax errors.
Returns: string | MarkdownString | undefined
Optional error encountered while loading the test. Note that this is not a test result and should only be used to represent errors in test discovery, such as syntax errors. **Returns:** `string | MarkdownString | undefined`
idcljs
(id test-item)Identifier for the TestItem. This is used to correlate
test results and tests in the document with those in the workspace
(test explorer). This cannot change for the lifetime of the TestItem,
and must be unique among its parent's direct children.
Returns: string
Identifier for the `TestItem`. This is used to correlate test results and tests in the document with those in the workspace (test explorer). This cannot change for the lifetime of the `TestItem`, and must be unique among its parent's direct children. **Returns:** `string`
labelcljs
(label test-item)Display name describing the test case.
Returns: string
Display name describing the test case. **Returns:** `string`
parentcljs
(parent test-item)The parent of this item. It's set automatically, and is undefined top-level items in the {@link TestController.items } and for items that aren't yet included in another item's {@link TestItem.children children}.
Returns: TestItem | undefined
The parent of this item. It's set automatically, and is undefined
top-level items in the {@link TestController.items } and for items that
aren't yet included in another item's {@link TestItem.children children}.
**Returns:** `TestItem | undefined`rangecljs
(range test-item)Location of the test item in its {@link TestItem.uri uri}.
This is only meaningful if the uri points to a file.
Returns: Range | undefined
Location of the test item in its {@link TestItem.uri uri}.
This is only meaningful if the `uri` points to a file.
**Returns:** `Range | undefined`set-busy!cljs
(set-busy! test-item value)Controls whether the item is shown as "busy" in the Test Explorer view. This is useful for showing status while discovering children.
Defaults to false.
Controls whether the item is shown as "busy" in the Test Explorer view. This is useful for showing status while discovering children. Defaults to `false`.
set-can-resolve-children!cljs
(set-can-resolve-children! test-item value)Indicates whether this test item may have children discovered by resolving.
If true, this item is shown as expandable in the Test Explorer view and expanding the item will cause {@link TestController.resolveHandler } to be invoked with the item.
Default to false.
Indicates whether this test item may have children discovered by resolving.
If true, this item is shown as expandable in the Test Explorer view and
expanding the item will cause {@link TestController.resolveHandler }
to be invoked with the item.
Default to `false`.set-description!cljs
(set-description! test-item value)Optional description that appears next to the label.
Optional description that appears next to the label.
set-error!cljs
(set-error! test-item value)Optional error encountered while loading the test.
Note that this is not a test result and should only be used to represent errors in test discovery, such as syntax errors.
Optional error encountered while loading the test. Note that this is not a test result and should only be used to represent errors in test discovery, such as syntax errors.
set-label!cljs
(set-label! test-item value)Display name describing the test case.
Display name describing the test case.
set-range!cljs
(set-range! test-item value)Location of the test item in its {@link TestItem.uri uri}.
This is only meaningful if the uri points to a file.
Location of the test item in its {@link TestItem.uri uri}.
This is only meaningful if the `uri` points to a file.set-sort-text!cljs
(set-sort-text! test-item value)A string that should be used when comparing this item
with other items. When falsy the {@link TestItem.label label}
is used.
A string that should be used when comparing this item
with other items. When `falsy` the {@link TestItem.label label}
is used.set-tags!cljs
(set-tags! test-item value)Tags associated with this test item. May be used in combination with {@link TestRunProfile.tag tags}, or simply as an organizational feature.
Tags associated with this test item. May be used in combination with
{@link TestRunProfile.tag tags}, or simply as an organizational feature.sort-textcljs
(sort-text test-item)A string that should be used when comparing this item
with other items. When falsy the {@link TestItem.label label}
is used.
Returns: string | undefined
A string that should be used when comparing this item
with other items. When `falsy` the {@link TestItem.label label}
is used.
**Returns:** `string | undefined`tagscljs
(tags test-item)Tags associated with this test item. May be used in combination with {@link TestRunProfile.tag tags}, or simply as an organizational feature.
Returns: readonly TestTag[]
Tags associated with this test item. May be used in combination with
{@link TestRunProfile.tag tags}, or simply as an organizational feature.
**Returns:** `readonly TestTag[]`uricljs
(uri test-item)URI this TestItem is associated with. May be a file or directory.
Returns: Uri | undefined
URI this `TestItem` is associated with. May be a file or directory. **Returns:** `Uri | undefined`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close