erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/web/docs/engine/reference/core/initialized.md
Marc Durdin 1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup 
Deprecate the following obsolete functions and properties:
* `keyman.helpURL`
* `keyman.util.rgba`
* `keyman.util.toFloat`
* `keyman.util.toNumber`
* `keyman.util.toNzString`

Use correct language for code blocks in Keyman Engine for Web
documentation.

Test-bot: skip
2026-08-12 16:07:22 +02:00

880 B
Raw Blame History

title
keyman.initialized

Summary

Keymanweb core module initialization state flag.

Syntax

    keyman.initialized

Type

Integer

Access

Read only

Return Value

  • 0, if Keyman Engine for Web is not initialized
  • 1, if Keyman Engine for Web has started initialization
  • 2, if Keyman Engine for Web is completely initialized

Description

The keyman.init() function is used to initialize Keyman. You can check this flag to see what the current initialization status is. You should not call functions other than keyman.init() until Keyman initialization is complete. As keyman.init() returns a Promise, the Promise fulfilment callback is the appropriate place to perform post-init steps.

History

  • 2.0: Keyman Engine for Web supports values 0, 1, or 2.
  • 16.0: Documentation updated to match implementation.