Interface UpgradeService

ReadonlyrestartedFromVersion

checkForUpgrade

• checkForUpgrade(installMethod?: InstallMethod): Promise<UpgradeCheckResult>

  Check whether a newer version of the CLI is available.

  The operating system and CPU architecture are always the detected values.

  Parameters

  • OptionalinstallMethod: InstallMethod

    optional InstallMethod override, defaults to the detected value.

  Returns Promise<UpgradeCheckResult>

  the UpgradeCheckResult. Runs to completion. Never rejects.

detectArch

• detectArch(): SupportedArch | undefined

  Detect the CPU architecture the CLI is currently running on.

  Returns SupportedArch | undefined

  the detected SupportedArch, or undefined if it is not supported.

detectInstallMethod

• detectInstallMethod(os: SupportedOs): Promise<InstallMethod | undefined>

  Detect the mechanism by which the CLI was installed for the specified operating system.

  Parameters

  • os: SupportedOs

    the SupportedOs to detect the install method for.

  Returns Promise<InstallMethod | undefined>

  the detected InstallMethod, or undefined if it could not be determined.

detectOs

• detectOs(): SupportedOs | undefined

  Detect the operating system the CLI is currently running on.

  Returns SupportedOs | undefined

  the detected SupportedOs, or undefined if it is not supported.

getCachedUpgradeCheckResult

• getCachedUpgradeCheckResult(): Promise<UpgradeCheckResult | undefined>

  Returns the most recently cached UpgradeCheckResult without performing a version check.

  Returns Promise<UpgradeCheckResult | undefined>

  the cached UpgradeCheckResult, or undefined if no result is cached. Never rejects.

getUpgradeCheckResult

• getUpgradeCheckResult(): Promise<UpgradeCheckResult>

  Returns the result of the version check that was started eagerly once this service's dependencies were set (or starts one now, with no install method override, if none has started yet).

  Returns Promise<UpgradeCheckResult>

  the UpgradeCheckResult. Never rejects.

refreshUpgradeCheckCache

• refreshUpgradeCheckCache(): Promise<UpgradeCheckResult>

  Performs a version check now and stores its result in the cache read by getCachedUpgradeCheckResult.

  Returns Promise<UpgradeCheckResult>

  the fresh UpgradeCheckResult. Never rejects.

upgrade

• upgrade(installMethod?: InstallMethod): Promise<UpgradeResult>

  Upgrade the CLI to the latest available version.

  The operating system and CPU architecture are always the detected values.

  Parameters

  • OptionalinstallMethod: InstallMethod

    optional InstallMethod override, defaults to the detected value.

  Returns Promise<UpgradeResult>

  the UpgradeResult. Never rejects.