spiegel-keyman/web/docs/engine/reference/core/build.md at b40c4b376b0cd15c1d08269a9ce641e554666a55

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-16 05:39:24 +00:00

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

562 B

Raw Blame History

title
build (deprecated)

Summary

Returns the patch component of the KeymanWeb version (major.minor.patch) as a number.

Syntax

keyman.build

Type

number

Access

Read only

Return Value

The patch component of the version, e.g. if the version is "18.0.249", then returns 249.

Description

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

History

19.0: deprecated

562 B Raw Blame History