mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-06 17:05: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.
118 lines
3.5 KiB
Markdown
118 lines
3.5 KiB
Markdown
## API Report File for "@keymanapp/kmc-model-info"
|
|
|
|
> 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 { CompilerOptions } from '@keymanapp/common-types';
|
|
import { KeymanCompiler } from '@keymanapp/common-types';
|
|
import { KeymanCompilerArtifact } from '@keymanapp/common-types';
|
|
import { KeymanCompilerArtifacts } from '@keymanapp/common-types';
|
|
import { KeymanCompilerResult } from '@keymanapp/common-types';
|
|
import { KmpJsonFile } from '@keymanapp/common-types';
|
|
|
|
// @public (undocumented)
|
|
export class ModelInfoCompiler implements KeymanCompiler {
|
|
constructor();
|
|
// (undocumented)
|
|
init(callbacks: CompilerCallbacks, options: ModelInfoCompilerOptions): Promise<boolean>;
|
|
run(inputFilename: string, outputFilename?: string): Promise<ModelInfoCompilerResult>;
|
|
// (undocumented)
|
|
write(artifacts: ModelInfoCompilerArtifacts): Promise<boolean>;
|
|
}
|
|
|
|
// @public (undocumented)
|
|
export interface ModelInfoCompilerArtifacts extends KeymanCompilerArtifacts {
|
|
// (undocumented)
|
|
model_info: KeymanCompilerArtifact;
|
|
}
|
|
|
|
// @public (undocumented)
|
|
export class ModelInfoCompilerMessages {
|
|
// (undocumented)
|
|
static ERROR_FileDoesNotExist: number;
|
|
// (undocumented)
|
|
static Error_FileDoesNotExist: (o: {
|
|
filename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_FileIsNotValid: number;
|
|
// (undocumented)
|
|
static Error_FileIsNotValid: (o: {
|
|
filename: string;
|
|
e: any;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_InvalidAuthorEmail: number;
|
|
// (undocumented)
|
|
static Error_InvalidAuthorEmail: (o: {
|
|
email: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_LicenseFileIsDamaged: number;
|
|
// (undocumented)
|
|
static Error_LicenseFileIsDamaged: (o: {
|
|
filename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_LicenseFileIsMissing: number;
|
|
// (undocumented)
|
|
static Error_LicenseFileIsMissing: (o: {
|
|
filename: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_LicenseIsNotValid: number;
|
|
// (undocumented)
|
|
static Error_LicenseIsNotValid: (o: {
|
|
filename: string;
|
|
message: string;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static ERROR_NoLicenseFound: number;
|
|
// (undocumented)
|
|
static Error_NoLicenseFound: () => CompilerEvent;
|
|
// (undocumented)
|
|
static FATAL_UnexpectedException: number;
|
|
// (undocumented)
|
|
static Fatal_UnexpectedException: (o: {
|
|
e: any;
|
|
}) => CompilerEvent;
|
|
// (undocumented)
|
|
static WARN_MetadataFieldInconsistent: number;
|
|
// (undocumented)
|
|
static Warn_MetadataFieldInconsistent: (o: {
|
|
field: string;
|
|
value: any;
|
|
expected: any;
|
|
}) => CompilerEvent;
|
|
}
|
|
|
|
// @public (undocumented)
|
|
export interface ModelInfoCompilerOptions extends CompilerOptions {
|
|
// (undocumented)
|
|
sources: ModelInfoSources;
|
|
}
|
|
|
|
// @public (undocumented)
|
|
export interface ModelInfoCompilerResult extends KeymanCompilerResult {
|
|
// (undocumented)
|
|
artifacts: ModelInfoCompilerArtifacts;
|
|
}
|
|
|
|
// @public (undocumented)
|
|
export class ModelInfoSources {
|
|
forPublishing: boolean;
|
|
kmpFileName: string;
|
|
kmpJsonData: KmpJsonFile.KmpJsonFile;
|
|
kpsFilename: string;
|
|
lastCommitDate?: string;
|
|
model_id: string;
|
|
modelFileName: string;
|
|
sourcePath: string;
|
|
}
|
|
|
|
// (No @packageDocumentation comment for this package)
|
|
|
|
```
|