erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spiegel-keyman/developer/docs/help/reference/api/kmc-analyze.analyzeoskcharacteruse.analyze.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.1 KiB
Raw Permalink Blame History

Home > @keymanapp/kmc-analyze > AnalyzeOskCharacterUse > analyze

AnalyzeOskCharacterUse.analyze() method

Analyzes a single source file for Unicode character usage. Can parse .kmn, .kvks, .keyman-touch-layout file formats. Can be called multiple times to collect results from more than one file. Use AnalyzeOskCharacterUse.getStrings() to retrieve results.

Note: analyze() collects key cap data, so calling this for a .kmn file will retrieve the key caps from the .kvks and .keyman-touch-layout files that it references, rather than key cap data from the .kmn file itself.

Signature:

analyze(file: string): Promise<boolean>;

Parameters

Parameter Type Description
file string relative or absolute path to a Keyman source file

Returns:

Promise<boolean>

true if the file is successfully loaded and parsed