mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 08:25:32 +00:00
b751336c13
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
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [@keymanapp/kmc-analyze](./kmc-analyze.md) > [AnalyzeOskCharacterUse](./kmc-analyze.analyzeoskcharacteruse.md) > [getStrings](./kmc-analyze.analyzeoskcharacteruse.getstrings.md)
|
|
|
|
## AnalyzeOskCharacterUse.getStrings() method
|
|
|
|
Returns the collected results from earlier calls to [AnalyzeOskCharacterUse.analyze()](./kmc-analyze.analyzeoskcharacteruse.analyze.md)<!-- -->. This generates a mapping from a key cap (one or more characters) to a PUA code, for use with `&displayMap`<!-- -->.
|
|
|
|
Three output formats are supported:
|
|
|
|
- .txt: tab-separated string format, with three columns: PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string.
|
|
|
|
- .md: formatted for documentation purposes. Generates a Markdown table (GFM) with PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string.
|
|
|
|
- .json: returns the final aggregated data as an array of strings, which can be joined to form a JSON blob of an object with a single member, `map`<!-- -->, which is an array of objects.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
getStrings(format?: '.txt' | '.md' | '.json'): string[];
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| format | '.txt' \| '.md' \| '.json' | _(Optional)_ file format to return - can be '.txt', '.md', or '.json' |
|
|
|
|
**Returns:**
|
|
|
|
string\[\]
|
|
|
|
an array of strings, formatted according to the `format` parameter.
|
|
|