Skip to main content

Type Alias: VersionIntegrationConfiguration

VersionIntegrationConfiguration: Omit<ApplicationFlag<CommandContext>, "name" | "aliases" | "global" | "run"> & object

Options for customizing the behavior of the version integration.

Type declaration​

alias?​

readonly optional alias: AvailableAlias | false

Single-character shorthand alias for this flag, defaults to v if not provided. Set to false to disable the alias entirely.

hook?​

readonly optional hook: keyof LifecycleHooks<CommandContext>

If getLatestVersion is provided in VersionIntegrationConfiguration.info, this option specifies when version check should run. Defaults to app:start.

info​

readonly info: VersionInfo

Values or callbacks to provide the version information for this application. See VersionInfo for more details. If getLatestVersion is provided, this integration will register a lifecycle hook (see VersionIntegrationConfiguration.hook) to check for the latest version of the application and print a warning to stderr if the current version is not the latest.

Defined in​

packages/core/src/application/integrations/version.ts:11