vlt / docs

    • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • Reference
  • Type Aliases
  • WhichOptions
  • WhichOptionsFindAll
  • WhichOptionsFindAllNoThrow
  • WhichOptionsFindAllThrow
  • WhichOptionsFindOne
  • WhichOptionsFindOneNoThrow
  • WhichOptionsFindOneThrow
  • WhichOptionsNoThrow
  • WhichOptionsThrow
  • Functions
  • which()
  • whichSync()
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/which
  6. /
  7. Reference

Reference

Type Aliases

WhichOptions

TypeScript
type WhichOptions = object;

Defined in: index.ts:65

Type declaration

NameType
all?boolean
delimiter?string
nothrow?boolean
path?string
pathExt?string

WhichOptionsFindAll

TypeScript
type WhichOptionsFindAll = WhichOptions & object;

Defined in: index.ts:73

Type declaration

NameType
alltrue

WhichOptionsFindAllNoThrow

TypeScript
type WhichOptionsFindAllNoThrow = WhichOptionsFindAll & WhichOptionsNoThrow;

Defined in: index.ts:84

WhichOptionsFindAllThrow

TypeScript
type WhichOptionsFindAllThrow = WhichOptionsFindAll & WhichOptionsThrow;

Defined in: index.ts:86

WhichOptionsFindOne

TypeScript
type WhichOptionsFindOne = WhichOptions & object;

Defined in: index.ts:74

Type declaration

NameType
all?false

WhichOptionsFindOneNoThrow

TypeScript
type WhichOptionsFindOneNoThrow = WhichOptionsFindOne & WhichOptionsNoThrow;

Defined in: index.ts:81

WhichOptionsFindOneThrow

TypeScript
type WhichOptionsFindOneThrow = WhichOptionsFindOne & WhichOptionsThrow;

Defined in: index.ts:79

WhichOptionsNoThrow

TypeScript
type WhichOptionsNoThrow = WhichOptions & object;

Defined in: index.ts:76

Type declaration

NameType
nothrowtrue

WhichOptionsThrow

TypeScript
type WhichOptionsThrow = WhichOptions & object;

Defined in: index.ts:77

Type declaration

NameType
nothrow?false

Functions

which()

Call Signature

TypeScript
function which(cmd): Promise<string>

Defined in: index.ts:89

Parameters
ParameterType
cmdstring
Returns

Promise<string>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string[]>

Defined in: index.ts:90

Parameters
ParameterType
cmdstring
optWhichOptionsFindAllNoThrow
Returns

Promise<null | string[]>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string>

Defined in: index.ts:94

Parameters
ParameterType
cmdstring
optWhichOptionsFindOneNoThrow
Returns

Promise<null | string>

Call Signature

TypeScript
function which(cmd, opt): Promise<string[]>

Defined in: index.ts:98

Parameters
ParameterType
cmdstring
optWhichOptionsFindAllThrow
Returns

Promise<string[]>

Call Signature

TypeScript
function which(cmd, opt): Promise<string>

Defined in: index.ts:102

Parameters
ParameterType
cmdstring
optWhichOptionsFindOneThrow
Returns

Promise<string>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string>

Defined in: index.ts:106

Parameters
ParameterType
cmdstring
optWhichOptionsFindOne
Returns

Promise<null | string>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string | string[]>

Defined in: index.ts:110

Parameters
ParameterType
cmdstring
optWhichOptionsNoThrow
Returns

Promise<null | string | string[]>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string[]>

Defined in: index.ts:114

Parameters
ParameterType
cmdstring
optWhichOptionsFindAll
Returns

Promise<null | string[]>

Call Signature

TypeScript
function which(cmd, opt): Promise<null | string | string[]>

Defined in: index.ts:118

Parameters
ParameterType
cmdstring
optWhichOptions
Returns

Promise<null | string | string[]>

whichSync()

Call Signature

TypeScript
function whichSync(cmd): string

Defined in: index.ts:155

Parameters
ParameterType
cmdstring
Returns

string

Call Signature

TypeScript
function whichSync(cmd, opt): null | string[]

Defined in: index.ts:156

Parameters
ParameterType
cmdstring
optWhichOptionsFindAllNoThrow
Returns

null | string[]

Call Signature

TypeScript
function whichSync(cmd, opt): null | string

Defined in: index.ts:160

Parameters
ParameterType
cmdstring
optWhichOptionsFindOneNoThrow
Returns

null | string

Call Signature

TypeScript
function whichSync(cmd, opt): string[]

Defined in: index.ts:164

Parameters
ParameterType
cmdstring
optWhichOptionsFindAllThrow
Returns

string[]

Call Signature

TypeScript
function whichSync(cmd, opt): string

Defined in: index.ts:168

Parameters
ParameterType
cmdstring
optWhichOptionsFindOneThrow
Returns

string

Call Signature

TypeScript
function whichSync(cmd, opt): null | string

Defined in: index.ts:172

Parameters
ParameterType
cmdstring
optWhichOptionsFindOne
Returns

null | string

Call Signature

TypeScript
function whichSync(cmd, opt): null | string | string[]

Defined in: index.ts:176

Parameters
ParameterType
cmdstring
optWhichOptionsNoThrow
Returns

null | string | string[]

Call Signature

TypeScript
function whichSync(cmd, opt): null | string[]

Defined in: index.ts:180

Parameters
ParameterType
cmdstring
optWhichOptionsFindAll
Returns

null | string[]

Call Signature

TypeScript
function whichSync(cmd, opt?): null | string | string[]

Defined in: index.ts:184

Parameters
ParameterType
cmdstring
opt?WhichOptions
Returns

null | string | string[]

Previous@vltpkg/whichNext@vltpkg/workspaces

On this page

  • Type Aliases
  • WhichOptions
  • WhichOptionsFindAll
  • WhichOptionsFindAllNoThrow
  • WhichOptionsFindAllThrow
  • WhichOptionsFindOne
  • WhichOptionsFindOneNoThrow
  • WhichOptionsFindOneThrow
  • WhichOptionsNoThrow
  • WhichOptionsThrow
  • Functions
  • which()
  • whichSync()

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now