mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-24 01:07:41 +00:00
101 lines
3.5 KiB
Markdown
101 lines
3.5 KiB
Markdown
## API Report File for "@keymanapp/kmc-convert"
|
|
|
|
> 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 { CompilerOptions } from '@keymanapp/developer-utils';
|
|
import { KeymanCompiler } from '@keymanapp/developer-utils';
|
|
import { KeymanCompilerArtifacts } from '@keymanapp/developer-utils';
|
|
import { KeymanCompilerResult } from '@keymanapp/developer-utils';
|
|
|
|
// @public
|
|
export class Converter implements KeymanCompiler {
|
|
init(callbacks: CompilerCallbacks, options: CompilerOptions): Promise<boolean>;
|
|
// Warning: (ae-forgotten-export) The symbol "ConverterResult" needs to be exported by the entry point main.d.ts
|
|
run(inputFilename: string, outputFilename?: string): Promise<ConverterResult>;
|
|
// Warning: (ae-forgotten-export) The symbol "ConverterArtifacts" needs to be exported by the entry point main.d.ts
|
|
write(artifacts: ConverterArtifacts): Promise<boolean>;
|
|
}
|
|
|
|
// Warning: (ae-internal-missing-underscore) The name "ConverterMessages" should be prefixed with an underscore because the declaration is marked as @internal
|
|
//
|
|
// @internal (undocumented)
|
|
export class ConverterMessages {
|
|
// (undocumented)
|
|
static ERROR_FileNotFound: number;
|
|
// (undocumented)
|
|
static Error_FileNotFound: (o?: {
|
|
inputFilename: string | null;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_InvalidFile: number;
|
|
// (undocumented)
|
|
static Error_InvalidFile: (o: {
|
|
errorText: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_NoConverterFound: number;
|
|
// (undocumented)
|
|
static Error_NoConverterFound: (o: {
|
|
inputFilename: string;
|
|
outputFilename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnableToConvert: number;
|
|
// (undocumented)
|
|
static Error_UnableToConvert: (o: {
|
|
inputFilename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnableToParse: number;
|
|
// (undocumented)
|
|
static Error_UnableToParse: () => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnableToRead: number;
|
|
// (undocumented)
|
|
static Error_UnableToRead: (o: {
|
|
errorText: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnableToReadFile: number;
|
|
// (undocumented)
|
|
static Error_UnableToReadFile: (o: {
|
|
inputFilename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnableToWrite: number;
|
|
// (undocumented)
|
|
static Error_UnableToWrite: (o: {
|
|
outputFilename: string;
|
|
errorText: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UndefinedActionDetected: number;
|
|
// (undocumented)
|
|
static Error_UndefinedActionDetected: (o: {
|
|
action: string;
|
|
KeyName: string;
|
|
keymapIndex: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_UnsupportedCharactersDetected: number;
|
|
// (undocumented)
|
|
static Error_UnsupportedCharactersDetected: (o: {
|
|
keymapIndex: string;
|
|
key: string;
|
|
KeyName: string;
|
|
output: string;
|
|
}) => CompilerEvent;
|
|
}
|
|
|
|
// @public
|
|
export interface ConverterOptions extends CompilerOptions {
|
|
failIfIncomplete?: boolean;
|
|
}
|
|
|
|
// (No @packageDocumentation comment for this package)
|
|
|
|
```
|