erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/web/docs/engine/reference/core/initialized.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo 
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

884 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.