spiegel-keyman/developer/docs/api/etc/kmc-analyze.api.md
Marc Durdin 9de8371cfe docs(developer): add/update API docs
Test-bot: skip
Build-bot: skip
2025-12-03 13:51:30 +01:00

87 lines
2.9 KiB
Markdown

## API Report File for "@keymanapp/kmc-analyze"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { CompilerCallbacks } from '@keymanapp/developer-utils';
import { CompilerEvent } from '@keymanapp/developer-utils';
import { Osk } from '@keymanapp/kmc-kmn';
// @public
export class AnalyzeOskCharacterUse {
constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions);
analyze(file: string): Promise<boolean>;
clear(): void;
getStrings(format?: '.txt' | '.md' | '.json'): string[];
// @internal (undocumented)
unitTestEndPoints: {
loadPreviousMap: (filename: string) => Osk.StringResult[];
addStrings: (strings: string[], filename: string) => void;
stringToUnicodeSequence: typeof AnalyzeOskCharacterUse.stringToUnicodeSequence;
};
}
// @public
export interface AnalyzeOskCharacterUseOptions {
includeCounts?: boolean;
mergeMapFile?: string;
puaBase?: number;
stripDottedCircle?: boolean;
}
// @public
export class AnalyzeOskRewritePua {
constructor(callbacks: CompilerCallbacks);
analyze(file: string, mapping: Osk.StringResult[]): Promise<boolean>;
clear(): void;
get data(): {
[index: string]: Uint8Array;
};
}
// Warning: (ae-internal-missing-underscore) The name "AnalyzerMessages" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class AnalyzerMessages {
// (undocumented)
static readonly FATAL_UnexpectedException: number;
// (undocumented)
static readonly Fatal_UnexpectedException: (o: {
e: any;
}) => CompilerEvent;
// (undocumented)
static readonly INFO_ScanningFile: number;
// (undocumented)
static readonly Info_ScanningFile: (o: {
type: string;
name: string;
}) => CompilerEvent;
// (undocumented)
static readonly WARN_PreviousMapDidIncludeCounts: number;
// (undocumented)
static readonly Warn_PreviousMapDidIncludeCounts: (o: {
filename: string;
}) => CompilerEvent;
// (undocumented)
static readonly WARN_PreviousMapDidNotIncludeCounts: number;
// (undocumented)
static readonly Warn_PreviousMapDidNotIncludeCounts: (o: {
filename: string;
}) => CompilerEvent;
// (undocumented)
static readonly WARN_PreviousMapFileCouldNotBeLoaded: number;
// (undocumented)
static readonly Warn_PreviousMapFileCouldNotBeLoaded: (o: {
filename: string;
}) => CompilerEvent;
// (undocumented)
static readonly WARN_PreviousMapFileCouldNotBeLoadedDueToError: number;
// (undocumented)
static readonly Warn_PreviousMapFileCouldNotBeLoadedDueToError: (o: {
filename: string;
e: any;
}) => CompilerEvent;
}
```