.deps.check

Liatir.deps.check() checks whether one command-line binary is available in PATH.

Signature

check(binary: string): Promise<DepCheckResult>

check(binary) -> dict

Example

const samtools = await Liatir.deps.check('samtools');

if (!samtools.available) {
  console.warn('Samtools is not available.');
}

samtools = ctx.liatir.deps.check('samtools')

if not samtools['available']:
    print('Samtools is not available.')

DepCheckResult

Field	Type	Description
available	boolean / bool	true if the binary is found in PATH.
binary	string / str	The name of the binary that was checked.
path	string | null / str | None	Full path to the binary, or null.
version	string | null / str | None	Detected version string, or null.

IMPORTANT

DepCheckResult fields are always camelCase in both Node and Python, because they come from the JSON response of the Liatir bridge.