spiegel-keyman/web/docs/engine/reference/core/version.md
Marc Durdin f1361a94f0 feat(web): add keyman.versionInfo API
KeymanWeb has long had `keyman.build` and `keyman.version`. Neither of
these properties expose the full version string, and consumers are
forced to manipulate them to get a partial version string.

This change deprecates both these properties, and introduces a new
`keyman.versionInfo` property, which returns an object with all the
version information, most importantly `full`.

Update documentation and add a unit test for this, following the unit
test pattern established throughout Keyman of a unit test filename
matching the implementation class. The `KeymanEngineBase` class is a
little difficult to instantiate so this unit test module currently has
a minimal instantiation which provides enough to fulfill the one
included test.

Test-bot: skip
2026-08-12 11:07:31 +02:00

587 B

title
version (deprecated)

Summary

Returns the major and minor components of the KeymanWeb version (major.minor.patch) as a string.

Syntax

keyman.version

Type

string

Access

Read only

Return Value

The major and minor components of the version, e.g. if the version is "18.0.249", then returns "18.0".

Description

This function is deprecated; to get the full KeymanWeb version string, use keyman.versionInfo.

History

19.0: deprecated

See also