Interface UpgradeService

Service allowing a Command to check for and install a newer version of the CLI itself.

interface UpgradeService {
    checkForUpgrade(
        os?: SupportedOs,
        arch?: SupportedArch,
        installMethod?: InstallMethod,
    ): Promise<UpgradeCheckResult>;
    detectArch(): SupportedArch | undefined;
    detectInstallMethod(os: SupportedOs): Promise<InstallMethod | undefined>;
    detectOs(): SupportedOs | undefined;
    getUpgradeCheckResult(): Promise<UpgradeCheckResult>;
    upgrade(
        os?: SupportedOs,
        arch?: SupportedArch,
        installMethod?: InstallMethod,
    ): Promise<UpgradeResult>;
}

Index

Methods

checkForUpgrade detectArch detectInstallMethod detectOs getUpgradeCheckResult upgrade

Methods

checkForUpgrade

checkForUpgrade(
    os?: SupportedOs,
    arch?: SupportedArch,
    installMethod?: InstallMethod,
): Promise<UpgradeCheckResult>
Check whether a newer version of the CLI is available.
Parameters
- Optionalos: SupportedOs
  optional SupportedOs override, defaults to the detected value.
- Optionalarch: SupportedArch
  optional SupportedArch override, defaults to the detected value.
- OptionalinstallMethod: InstallMethod
  optional InstallMethod override, defaults to the detected value.
Returns Promise<UpgradeCheckResult>
the UpgradeCheckResult. Runs to completion. Never rejects.
- Defined in src/service/core/UpgradeService.ts:99

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.
- Defined in src/service/core/UpgradeService.ts:79

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.
- Defined in src/service/core/UpgradeService.ts:88

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.
- Defined in src/service/core/UpgradeService.ts:72

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 default/no-override detection, if none has started yet).

Returns Promise<UpgradeCheckResult>
the UpgradeCheckResult. Never rejects.
- Defined in src/service/core/UpgradeService.ts:127

upgrade

upgrade(
    os?: SupportedOs,
    arch?: SupportedArch,
    installMethod?: InstallMethod,
): Promise<UpgradeResult>
Upgrade the CLI to the latest available version.
Parameters
- Optionalos: SupportedOs
  optional SupportedOs override, defaults to the detected value.
- Optionalarch: SupportedArch
  optional SupportedArch override, defaults to the detected value.
- OptionalinstallMethod: InstallMethod
  optional InstallMethod override, defaults to the detected value.
Returns Promise<UpgradeResult>
the UpgradeResult. Never rejects.
- Defined in src/service/core/UpgradeService.ts:114