dots.vscode.test-run-profile

Liking cljdoc? Tell your friends :D

ClojureScript only.

configure-handler
default?
dispose
kind
label
load-detailed-coverage
on-did-change-default
run-handler
set-configure-handler!
set-is-default!
set-label!
set-load-detailed-coverage!
set-on-did-change-default!
set-run-handler!
set-supports-continuous-run!
set-tag!
supports-continuous-run?
tag

A TestRunProfile describes one way to execute tests in a {@link TestController }.

A TestRunProfile describes one way to execute tests in a {@link TestController }.

raw docstring

configure-handler^cljs

(configure-handler test-run-profile)

If this method is present, a configuration gear will be present in the UI, and this method will be invoked when it's clicked. When called, you can take other editor actions, such as showing a quick pick or opening a configuration file.

Returns: (() => void) | undefined

If this method is present, a configuration gear will be present in the
UI, and this method will be invoked when it's clicked. When called,
you can take other editor actions, such as showing a quick pick or
opening a configuration file.

**Returns:** `(() => void) | undefined`

source raw docstring

default?^cljs

(default? test-run-profile)

Controls whether this profile is the default action that will be taken when its kind is actioned. For example, if the user clicks the generic "run all" button, then the default profile for {@link TestRunProfileKind.Run } will be executed, although the user can configure this.

Changes the user makes in their default profiles will be reflected in this property after a {@link onDidChangeDefault } event.

Returns: boolean

Controls whether this profile is the default action that will
be taken when its kind is actioned. For example, if the user clicks
the generic "run all" button, then the default profile for
{@link TestRunProfileKind.Run } will be executed, although the
user can configure this.

Changes the user makes in their default profiles will be reflected
in this property after a {@link onDidChangeDefault } event.

**Returns:** `boolean`

source raw docstring

dispose^cljs

(dispose test-run-profile)

Deletes the run profile.

Returns: void

Deletes the run profile.

**Returns:** `void`

source raw docstring

kind^cljs

(kind test-run-profile)

Configures what kind of execution this profile controls. If there are no profiles for a kind, it will not be available in the UI.

Returns: TestRunProfileKind

Configures what kind of execution this profile controls. If there
are no profiles for a kind, it will not be available in the UI.

**Returns:** `TestRunProfileKind`

source raw docstring

label^cljs

(label test-run-profile)

Label shown to the user in the UI.

Note that the label has some significance if the user requests that tests be re-run in a certain way. For example, if tests were run normally and the user requests to re-run them in debug mode, the editor will attempt use a configuration with the same label of the Debug kind. If there is no such configuration, the default will be used.

Returns: string

Label shown to the user in the UI.

Note that the label has some significance if the user requests that
tests be re-run in a certain way. For example, if tests were run
normally and the user requests to re-run them in debug mode, the editor
will attempt use a configuration with the same label of the `Debug`
kind. If there is no such configuration, the default will be used.

**Returns:** `string`

source raw docstring

load-detailed-coverage^cljs

(load-detailed-coverage test-run-profile)

An extension-provided function that provides detailed statement and function-level coverage for a file. The editor will call this when more detail is needed for a file, such as when it's opened in an editor or expanded in the Test Coverage view.

The {@link FileCoverage } object passed to this function is the same instance emitted on {@link TestRun.addCoverage } calls associated with this profile.

Returns: ((testRun: TestRun, fileCoverage: FileCoverage, token: CancellationToken) => Thenable<FileCoverageDetail[]>) | undefined

An extension-provided function that provides detailed statement and
function-level coverage for a file. The editor will call this when more
detail is needed for a file, such as when it's opened in an editor or
expanded in the **Test Coverage** view.

The {@link FileCoverage } object passed to this function is the same instance
emitted on {@link TestRun.addCoverage } calls associated with this profile.

**Returns:** `((testRun: TestRun, fileCoverage: FileCoverage, token: CancellationToken) => Thenable<FileCoverageDetail[]>) | undefined`

source raw docstring

on-did-change-default^cljs

(on-did-change-default test-run-profile)

(on-did-change-default test-run-profile listener)

(on-did-change-default test-run-profile listener this-args)

(on-did-change-default test-run-profile listener this-args disposables)

Fired when a user has changed whether this is a default profile. The event contains the new value of {@link isDefault }

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Fired when a user has changed whether this is a default profile. The
event contains the new value of {@link isDefault }

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

run-handler^cljs

(run-handler test-run-profile)

Handler called to start a test run. When invoked, the function should call {@link TestController.createTestRun } at least once, and all test runs associated with the request should be created before the function returns or the returned promise is resolved.

If {@link supportsContinuousRun } is set, then {@link TestRunRequest.continuous } may be true. In this case, the profile should observe changes to source code and create new test runs by calling {@link TestController.createTestRun }, until the cancellation is requested on the token.

Returns: (request: TestRunRequest, token: CancellationToken) => void | Thenable<void>

Handler called to start a test run. When invoked, the function should call
{@link TestController.createTestRun } at least once, and all test runs
associated with the request should be created before the function returns
or the returned promise is resolved.

If {@link supportsContinuousRun } is set, then {@link TestRunRequest.continuous }
may be `true`. In this case, the profile should observe changes to
source code and create new test runs by calling {@link TestController.createTestRun },
until the cancellation is requested on the `token`.

**Returns:** `(request: TestRunRequest, token: CancellationToken) => void | Thenable<void>`

source raw docstring

set-configure-handler!^cljs

(set-configure-handler! test-run-profile value)

If this method is present, a configuration gear will be present in the
UI, and this method will be invoked when it's clicked. When called,
you can take other editor actions, such as showing a quick pick or
opening a configuration file.

source raw docstring

set-is-default!^cljs

(set-is-default! test-run-profile value)

Changes the user makes in their default profiles will be reflected in this property after a {@link onDidChangeDefault } event.

Controls whether this profile is the default action that will
be taken when its kind is actioned. For example, if the user clicks
the generic "run all" button, then the default profile for
{@link TestRunProfileKind.Run } will be executed, although the
user can configure this.

Changes the user makes in their default profiles will be reflected
in this property after a {@link onDidChangeDefault } event.

source raw docstring

set-label!^cljs

(set-label! test-run-profile value)

Label shown to the user in the UI.

Label shown to the user in the UI.

Note that the label has some significance if the user requests that
tests be re-run in a certain way. For example, if tests were run
normally and the user requests to re-run them in debug mode, the editor
will attempt use a configuration with the same label of the `Debug`
kind. If there is no such configuration, the default will be used.

source raw docstring

set-load-detailed-coverage!^cljs

(set-load-detailed-coverage! test-run-profile value)

The {@link FileCoverage } object passed to this function is the same instance emitted on {@link TestRun.addCoverage } calls associated with this profile.

An extension-provided function that provides detailed statement and
function-level coverage for a file. The editor will call this when more
detail is needed for a file, such as when it's opened in an editor or
expanded in the **Test Coverage** view.

The {@link FileCoverage } object passed to this function is the same instance
emitted on {@link TestRun.addCoverage } calls associated with this profile.

source raw docstring

set-on-did-change-default!^cljs

(set-on-did-change-default! test-run-profile value)

Fired when a user has changed whether this is a default profile. The event contains the new value of {@link isDefault }

Fired when a user has changed whether this is a default profile. The
event contains the new value of {@link isDefault }

source raw docstring

set-run-handler!^cljs

(set-run-handler! test-run-profile value)

Handler called to start a test run. When invoked, the function should call
{@link TestController.createTestRun } at least once, and all test runs
associated with the request should be created before the function returns
or the returned promise is resolved.

If {@link supportsContinuousRun } is set, then {@link TestRunRequest.continuous }
may be `true`. In this case, the profile should observe changes to
source code and create new test runs by calling {@link TestController.createTestRun },
until the cancellation is requested on the `token`.

source raw docstring

set-supports-continuous-run!^cljs

(set-supports-continuous-run! test-run-profile value)

Whether this profile supports continuous running of requests. If so, then {@link TestRunRequest.continuous } may be set to true. Defaults to false.

Whether this profile supports continuous running of requests. If so,
then {@link TestRunRequest.continuous } may be set to `true`. Defaults
to false.

source raw docstring

set-tag!^cljs

(set-tag! test-run-profile value)

Associated tag for the profile. If this is set, only {@link TestItem } instances with the same tag will be eligible to execute in this profile.

Associated tag for the profile. If this is set, only {@link TestItem }
instances with the same tag will be eligible to execute in this profile.

source raw docstring

supports-continuous-run?^cljs

(supports-continuous-run? test-run-profile)

Whether this profile supports continuous running of requests. If so, then {@link TestRunRequest.continuous } may be set to true. Defaults to false.

Returns: boolean

Whether this profile supports continuous running of requests. If so,
then {@link TestRunRequest.continuous } may be set to `true`. Defaults
to false.

**Returns:** `boolean`

source raw docstring

tag^cljs

(tag test-run-profile)

Associated tag for the profile. If this is set, only {@link TestItem } instances with the same tag will be eligible to execute in this profile.

Returns: TestTag | undefined

Associated tag for the profile. If this is set, only {@link TestItem }
instances with the same tag will be eligible to execute in this profile.

**Returns:** `TestTag | undefined`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close