Reference

Functions

cmdShim()

function cmdShim(
   from, 
   to, 
remover): Promise<void>

Defined in: index.ts:46

Parameters

Returns

Promise<void>

cmdShimIfExists()

function cmdShimIfExists(
   from, 
   to, 
remover): Promise<void>

Defined in: index.ts:33

Parameters

Returns

Promise<void>

findCmdShim()

function findCmdShim(path): Promise<[string, string]>

Defined in: read.ts:57

Find a matching cmd, cygwin, powershell, or symlink executable, and return the matching file and the target it references in a [string,string] tuple if found, or throw if not found.

Parameters

Returns

Promise<[string, string]>

findCmdShimIfExists()

function findCmdShimIfExists(path): Promise<undefined | [string, string]>

Defined in: read.ts:42

Find a matching cmd, cygwin, powershell, or symlink executable, and return the matching file and the target it references in a [string,string] tuple if found, or undefined if not.

Parameters

Returns

Promise<undefined | [string, string]>

readCmdShim()

function readCmdShim(path): Promise<string>

Defined in: read.ts:88

Read the specified executable shim, returning the target it references. Raise an error if it does not exist or cannot be read.

Parameters

Returns

Promise<string>

readCmdShimIfExists()

function readCmdShimIfExists(path): Promise<undefined | string>

Defined in: read.ts:72

Read the specified executable shim if it exists, returning the target it references. Return undefined if it does not exist or cannot be dereferenced.

Parameters

Returns

Promise<undefined | string>