spiegel-keyman/developer/docs/api/etc/kmc-model.api.md

API Report File for "@keymanapp/kmc-model"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="@keymanapp/models-types" />

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';

// @public (undocumented)
export class LexicalModelCompiler implements KeymanCompiler {
    generateLexicalModelCode(model_id: string, modelSource: LexicalModelSource, sourcePath: string): string;
    // (undocumented)
    init(callbacks: CompilerCallbacks, _options: CompilerOptions): Promise<boolean>;
    // Warning: (ae-forgotten-export) The symbol "LexicalModelSource" needs to be exported by the entry point main.d.ts
    loadFromFilename(filename: string): LexicalModelSource;
    // Warning: (ae-forgotten-export) The symbol "LexicalModelCompilerResult" needs to be exported by the entry point main.d.ts
    //
    // (undocumented)
    run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;
    // (undocumented)
    transpileSources(sources: Array<string>): Array<string>;
    // Warning: (ae-forgotten-export) The symbol "LexicalModelCompilerArtifacts" needs to be exported by the entry point main.d.ts
    //
    // (undocumented)
    write(artifacts: LexicalModelCompilerArtifacts): Promise<boolean>;
}

// @public (undocumented)
export class ModelCompilerMessages {
    // (undocumented)
    static ERROR_NoDefaultExport: number;
    // (undocumented)
    static Error_NoDefaultExport: () => CompilerEvent;
    // (undocumented)
    static ERROR_SearchTermToKeyMustBeExplicitlySpecified: number;
    // (undocumented)
    static Error_SearchTermToKeyMustBeExplicitlySpecified: () => CompilerEvent;
    // (undocumented)
    static ERROR_UnimplementedModelFormat: number;
    // (undocumented)
    static Error_UnimplementedModelFormat: (o: {
        format: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_UnknownModelFormat: number;
    // (undocumented)
    static Error_UnknownModelFormat: (o: {
        format: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_UnknownWordBreaker: number;
    // (undocumented)
    static Error_UnknownWordBreaker: (o: {
        spec: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_UnsupportedScriptOverride: number;
    // (undocumented)
    static Error_UnsupportedScriptOverride: (o: {
        option: string;
    }) => CompilerEvent;
    // (undocumented)
    static ERROR_UTF16BEUnsupported: number;
    // (undocumented)
    static Error_UTF16BEUnsupported: () => CompilerEvent;
    // (undocumented)
    static FATAL_UnexpectedException: number;
    // (undocumented)
    static Fatal_UnexpectedException: (o: {
        e: any;
    }) => CompilerEvent;
    // (undocumented)
    static HINT_DuplicateWordInSameFile: number;
    // (undocumented)
    static Hint_DuplicateWordInSameFile: (o: {
        wordform: string;
    }) => CompilerEvent;
    // (undocumented)
    static HINT_MixedNormalizationForms: number;
    // (undocumented)
    static Hint_MixedNormalizationForms: (o: {
        wordform: string;
    }) => CompilerEvent;
}

// (No @packageDocumentation comment for this package)