Liking cljdoc? Tell your friends :D

dots.vscode.source-control

An source control is able to provide {@link SourceControlResourceState resource states} to the editor and interact with the editor in several source control related ways.

An source control is able to provide {@link SourceControlResourceState resource states}
to the editor and interact with the editor in several source control related ways.
raw docstring

accept-input-commandcljs

(accept-input-command source-control)

Optional accept input command.

This command will be invoked when the user accepts the value in the Source Control input.

Returns: Command | undefined

Optional accept input command.

This command will be invoked when the user accepts the value
in the Source Control input.

**Returns:** `Command | undefined`
sourceraw docstring

commit-templatecljs

(commit-template source-control)

Optional commit template string.

The Source Control viewlet will populate the Source Control input with this value when appropriate.

Returns: string | undefined

Optional commit template string.

The Source Control viewlet will populate the Source Control
input with this value when appropriate.

**Returns:** `string | undefined`
sourceraw docstring

countcljs

(count source-control)

The UI-visible count of {@link SourceControlResourceState resource states} of this source control.

If undefined, this source control will

  • display its UI-visible count as zero, and
  • contribute the count of its {@link SourceControlResourceState resource states} to the UI-visible aggregated count for all source controls

Returns: number | undefined

The UI-visible count of {@link SourceControlResourceState resource states} of
this source control.

If undefined, this source control will
- display its UI-visible count as zero, and
- contribute the count of its {@link SourceControlResourceState resource states} to the UI-visible aggregated count for all source controls

**Returns:** `number | undefined`
sourceraw docstring

create-resource-groupcljs

(create-resource-group source-control id label)

Create a new {@link SourceControlResourceGroup resource group}.

Parameters:

  • id: string
  • label: string

Returns: SourceControlResourceGroup

Create a new {@link SourceControlResourceGroup resource group}.

**Parameters:**
- `id`: `string`
- `label`: `string`

**Returns:** `SourceControlResourceGroup`
sourceraw docstring

disposecljs

(dispose source-control)

Dispose this source control.

Returns: void

Dispose this source control.

**Returns:** `void`
sourceraw docstring

idcljs

(id source-control)

The id of this source control.

Returns: string

The id of this source control.

**Returns:** `string`
sourceraw docstring

input-boxcljs

(input-box source-control)

The {@link SourceControlInputBox input box} for this source control.

Returns: SourceControlInputBox

The {@link SourceControlInputBox input box} for this source control.

**Returns:** `SourceControlInputBox`
sourceraw docstring

labelcljs

(label source-control)

The human-readable label of this source control.

Returns: string

The human-readable label of this source control.

**Returns:** `string`
sourceraw docstring

quick-diff-providercljs

(quick-diff-provider source-control)

An optional {@link QuickDiffProvider quick diff provider}.

Returns: QuickDiffProvider | undefined

An optional {@link QuickDiffProvider quick diff provider}.

**Returns:** `QuickDiffProvider | undefined`
sourceraw docstring

root-uricljs

(root-uri source-control)

The (optional) Uri of the root of this source control.

Returns: Uri | undefined

The (optional) Uri of the root of this source control.

**Returns:** `Uri | undefined`
sourceraw docstring

set-accept-input-command!cljs

(set-accept-input-command! source-control value)

Optional accept input command.

This command will be invoked when the user accepts the value in the Source Control input.

Optional accept input command.

This command will be invoked when the user accepts the value
in the Source Control input.
sourceraw docstring

set-commit-template!cljs

(set-commit-template! source-control value)

Optional commit template string.

The Source Control viewlet will populate the Source Control input with this value when appropriate.

Optional commit template string.

The Source Control viewlet will populate the Source Control
input with this value when appropriate.
sourceraw docstring

set-count!cljs

(set-count! source-control value)

The UI-visible count of {@link SourceControlResourceState resource states} of this source control.

If undefined, this source control will

  • display its UI-visible count as zero, and
  • contribute the count of its {@link SourceControlResourceState resource states} to the UI-visible aggregated count for all source controls
The UI-visible count of {@link SourceControlResourceState resource states} of
this source control.

If undefined, this source control will
- display its UI-visible count as zero, and
- contribute the count of its {@link SourceControlResourceState resource states} to the UI-visible aggregated count for all source controls
sourceraw docstring

set-quick-diff-provider!cljs

(set-quick-diff-provider! source-control value)

An optional {@link QuickDiffProvider quick diff provider}.

An optional {@link QuickDiffProvider quick diff provider}.
sourceraw docstring

set-status-bar-commands!cljs

(set-status-bar-commands! source-control value)

Optional status bar commands.

These commands will be displayed in the editor's status bar.

Optional status bar commands.

These commands will be displayed in the editor's status bar.
sourceraw docstring

status-bar-commandscljs

(status-bar-commands source-control)

Optional status bar commands.

These commands will be displayed in the editor's status bar.

Returns: Command[] | undefined

Optional status bar commands.

These commands will be displayed in the editor's status bar.

**Returns:** `Command[] | undefined`
sourceraw docstring

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

× close