Skip to main content

Module: util/targetUtils

Functions​

createThatMark​

▸ createThatMark(targets, ranges?): SelectionWithEditor[]

Parameters​

NameType
targetsTarget[]
ranges?Range[]

Returns​

SelectionWithEditor[]

Defined in​

util/targetUtils.ts:91

ensureSingleEditor​

▸ ensureSingleEditor(targets): TextEditor

Parameters​

NameType
targetsTarget[]

Returns​

TextEditor

Defined in​

util/targetUtils.ts:16

ensureSingleTarget​

▸ ensureSingleTarget(targets): Target

Parameters​

NameType
targetsTarget[]

Returns​

Target

Defined in​

util/targetUtils.ts:30

flashTargets​

▸ flashTargets(ide, targets, style, getRange?): Promise<void>

Parameters​

NameTypeDefault value
ideIDEundefined
targetsTarget[]undefined
styleFlashStyleundefined
getRange(target: Target) => undefined | RangegetContentRange

Returns​

Promise<void>

Defined in​

util/targetUtils.ts:116

getContentRange​

▸ getContentRange(target): Range

Parameters​

NameType
targetTarget

Returns​

Range

Defined in​

util/targetUtils.ts:87

groupTargetsForEachEditor​

▸ groupTargetsForEachEditor(targets): [TextEditor, Target[]][]

Parameters​

NameType
targetsTarget[]

Returns​

[TextEditor, Target[]][]

Defined in​

util/targetUtils.ts:69

runForEachEditor​

▸ runForEachEditor<T, U>(targets, getEditor, func): Promise<U[]>

Type parameters​

Name
T
U

Parameters​

NameType
targetsT[]
getEditor(target: T) => TextEditor
func(editor: TextEditor, editorTargets: T[]) => Promise<U>

Returns​

Promise<U[]>

Defined in​

util/targetUtils.ts:38

runOnTargetsForEachEditor​

▸ runOnTargetsForEachEditor<T>(targets, func): Promise<T[]>

Type parameters​

Name
T

Parameters​

NameType
targetsTarget[]
func(editor: TextEditor, targets: Target[]) => Promise<T>

Returns​

Promise<T[]>

Defined in​

util/targetUtils.ts:50

runOnTargetsForEachEditorSequentially​

▸ runOnTargetsForEachEditorSequentially<T>(targets, func): Promise<T[]>

Type parameters​

Name
T

Parameters​

NameType
targetsTarget[]
func(editor: TextEditor, targets: Target[]) => Promise<T>

Returns​

Promise<T[]>

Defined in​

util/targetUtils.ts:57

toGeneralizedRange​

▸ toGeneralizedRange(target): GeneralizedRange

Parameters​

NameType
targetTarget

Returns​

GeneralizedRange

Defined in​

util/targetUtils.ts:110