External module "util"

Index

Enumerations

Ordering

Classes

Interfaces

Type aliases

Functions

Type aliases

NormalizationSetting

NormalizationSetting: "always" | "never" | "platform"

ProgressHandle

ProgressHandle: vscode.Progress<ProgressReport>

Functions

_killTree

_killTree(pid: number): Promise<void>

- Defined in util.ts:253
Parameters
- pid: number
Returns Promise<void>

chain

chain<T>(...iter: Iterable<T>[]): Iterable<T>

- Defined in util.ts:162
Type parameters
- T
Parameters
- Rest ...iter: Iterable<T>[]
Returns Iterable<T>

cmakeify

cmakeify(value: string | number | true | false | string[]): CMakeValue

- Defined in util.ts:220
Parameters
- value: string | number | true | false | string[]
Returns CMakeValue

compare

compare(a: any, b: any): Ordering

- Defined in util.ts:428
Parameters
- a: any
- b: any
Returns Ordering

compareVersions

compareVersions(a: Version | string, b: Version | string): Ordering

- Defined in util.ts:388
Parameters
- a: Version | string
- b: Version | string
Returns Ordering

dropNulls

dropNulls<T>(items: (undefined | null | T)[]): T[]

- Defined in util.ts:378
Type parameters
- T
Parameters
- items: (undefined | null | T)[]
Returns T[]

escapeStringForRegex

escapeStringForRegex(str: string): string

- Defined in util.ts:10
Escape a string so it can be used as a regular expression

Parameters
- str: string
Returns string

find

find<T>(iter: Iterable<T>, predicate: function): T | undefined

- Defined in util.ts:177
Type parameters
- T
Parameters
- iter: Iterable<T>
- predicate: function
  - - (value: T): boolean
    - Parameters
      - value: T
      Returns boolean
Returns T | undefined

flatMap

flatMap<In, Out>(rng: Iterable<In>, fn: function): Iterable<Out>

- Defined in util.ts:317
Type parameters
- In
- Out
Parameters
- rng: Iterable<In>
- fn: function
  - - (item: In): Iterable<Out>
    - Parameters
      - item: In
      Returns Iterable<Out>
Returns Iterable<Out>

heavyNormalizePath

heavyNormalizePath(p: string): string

- Defined in util.ts:100
Parameters
- p: string
Returns string

isMultiConfGenerator

isMultiConfGenerator(gen: string): boolean

- Defined in util.ts:290
Parameters
- gen: string
Returns boolean

isTruthy

isTruthy(value: undefined | null | string | number | true | false): boolean

- Defined in util.ts:133
Check if a value is "truthy" according to CMake's own language rules

Parameters
- value: undefined | null | string | number | true | false
  
  The value to check
Returns boolean

lexicographicalCompare

lexicographicalCompare(a: Iterable<string>, b: Iterable<string>): number

- Defined in util.ts:463
Parameters
- a: Iterable<string>
- b: Iterable<string>
Returns number

lightNormalizePath

lightNormalizePath(p: string): string

- Defined in util.ts:92
Parameters
- p: string
Returns string

map

map<In, Out>(iter: Iterable<In>, proj: function): Iterable<Out>

- Defined in util.ts:156
Map an iterable by some projection function

Type parameters
- In
- Out
Parameters
- iter: Iterable<In>
  
  An iterable to map
- proj: function
  
  The projection function
  - - (arg: In): Out
    - Parameters
      - arg: In
      Returns Out
Returns Iterable<Out>

mergeEnvironment

mergeEnvironment(...env: EnvironmentVariables[]): EnvironmentVariables

- Defined in util.ts:326
Parameters
- Rest ...env: EnvironmentVariables[]
Returns EnvironmentVariables

normalizeEnvironmentVarname

normalizeEnvironmentVarname(varname: string): string

- Defined in util.ts:342
Parameters
- varname: string
Returns string

normalizePath

normalizePath(p: string, opt: PathNormalizationOptions): string

- Defined in util.ts:51
Completely normalize/canonicalize a path. Using path.normalize isn't sufficient. We want convert all paths to use POSIX separators, remove redundant separators, and sometimes normalize the case of the path.

Parameters
- p: string
  
  The input path
- opt: PathNormalizationOptions
  
  Options to control the normalization
Returns string

The normalized path

objectPairs

objectPairs<V>(obj: object): [string, V][]

- Defined in util.ts:147
Generate an array of key-value pairs from an object using getOwnPropertyNames

Type parameters
- V
Parameters
- obj: object
  
  The object to iterate
  - [key: string]: V
Returns [string, V][]

parseCompileDefinition

parseCompileDefinition(str: string): [string, string | null]

- Defined in util.ts:346
Parameters
- str: string
Returns [string, string | null]

parseVersion

parseVersion(str: string): Version

- Defined in util.ts:301
Parameters
- str: string
Returns Version

platformNormalizePath

platformNormalizePath(p: string): string

- Defined in util.ts:96
Parameters
- p: string
Returns string

platformPathCompare

platformPathCompare(a: string, b: string): Ordering

- Defined in util.ts:440
Parameters
- a: string
- b: string
Returns Ordering

platformPathEquivalent

platformPathEquivalent(a: string, b: string): boolean

- Defined in util.ts:444
Parameters
- a: string
- b: string
Returns boolean

product

product<T>(arrays: T[][]): T[][]

- Defined in util.ts:195
Type parameters
- T
Parameters
- arrays: T[][]
Returns T[][]

randint

randint(min: number, max: number): number

- Defined in util.ts:192
Generate a random integral value.

Parameters
- min: number
  
  Minimum value
- max: number
  
  Maximum value
Returns number

reduce

reduce<In, Out>(iter: Iterable<In>, init: Out, mapper: function): Out

- Defined in util.ts:170
Type parameters
- In
- Out
Parameters
- iter: Iterable<In>
- init: Out
- mapper: function
  - - (acc: Out, el: In): Out
    - Parameters
      - acc: Out
      - el: In
      Returns Out
Returns Out

removeAllPatterns

removeAllPatterns(str: string, patterns: string[]): string

- Defined in util.ts:31
Remove all occurrences of a list of strings from a string.

Parameters
- str: string
  
  The input string
- patterns: string[]
  
  Strings to remove from str
Returns string

The modified string

replaceAll

replaceAll(str: string, needle: string, what: string): string

- Defined in util.ts:19
Replace all occurrences of needle in str with what

Parameters
- str: string
  
  The input string
- needle: string
  
  The search string
- what: string
  
  The value to insert in place of needle
Returns string

The modified string

resolvePath

resolvePath(inpath: string, base: string): string

- Defined in util.ts:104
Parameters
- inpath: string
- base: string
Returns string

setContextValue

setContextValue(key: string, value: any): Thenable<void>

- Defined in util.ts:448
Parameters
- key: string
- value: any
Returns Thenable<void>

splitCommandLine

splitCommandLine(cmd: string): string[]

- Defined in util.ts:281
Parameters
- cmd: string
Returns string[]

splitPath

splitPath(p: string): string[]

- Defined in util.ts:112
Split a path into its elements.

Parameters
- p: string
  
  The path to split
Returns string[]

termProc

termProc(child: ChildProcess): Promise<boolean>

- Defined in util.ts:244
Parameters
- child: ChildProcess
Returns Promise<boolean>

thisExtension

thisExtension(): Extension<any>

- Defined in util.ts:355
Returns Extension<any>

thisExtensionPackage

thisExtensionPackage(): PackageJSON

- Defined in util.ts:368
Returns PackageJSON

thisExtensionPath

thisExtensionPath(): string

- Defined in util.ts:376
Returns string

versionEquals

versionEquals(lhs: Version | string, rhs: Version | string): boolean

- Defined in util.ts:420
Parameters
- lhs: Version | string
- rhs: Version | string
Returns boolean

versionGreater

versionGreater(lhs: Version | string, rhs: Version | string): boolean

- Defined in util.ts:416
Parameters
- lhs: Version | string
- rhs: Version | string
Returns boolean

versionLess

versionLess(lhs: Version | string, rhs: Version | string): boolean

- Defined in util.ts:424
Parameters
- lhs: Version | string
- rhs: Version | string
Returns boolean

versionToString

versionToString(ver: Version): string

- Defined in util.ts:315
Parameters
- ver: Version
Returns string

Generated using TypeDoc