<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@keymanapp/kmc-analyze](./kmc-analyze.md) &gt; [AnalyzeOskCharacterUse](./kmc-analyze.analyzeoskcharacteruse.md) &gt; [analyze](./kmc-analyze.analyzeoskcharacteruse.analyze.md)

## 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()](./kmc-analyze.analyzeoskcharacteruse.getstrings.md) 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:**

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

## Parameters

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

**Returns:**

Promise&lt;boolean&gt;

true if the file is successfully loaded and parsed