mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-06 08:55:34 +00:00
3b45c543bf
Relates to #10207. Note: reduces the API surface by removing members which should be internal. Fixes a few minor typos in other API docs. Adds missing docs for kmc-kmn also.
55 lines
1.6 KiB
Markdown
55 lines
1.6 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/common-types';
|
|
import { CompilerEvent } from '@keymanapp/common-types';
|
|
import { Osk } from '@keymanapp/developer-utils';
|
|
|
|
// @public
|
|
export class AnalyzeOskCharacterUse {
|
|
constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOptions);
|
|
analyze(file: string): Promise<boolean>;
|
|
clear(): void;
|
|
getStrings(format?: '.txt' | '.md' | '.json'): string[];
|
|
}
|
|
|
|
// @public
|
|
export interface AnalyzeOskCharacterUseOptions {
|
|
includeCounts?: boolean;
|
|
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;
|
|
}
|
|
|
|
```
|