anylang/scheduling/index.d.ts

A translator's kit that uses the free APIs of Google Translate, Yandex, Bing, ChatGPT, and other LLMs

export { Scheduler } from './Scheduler';
export { SchedulerWithCache } from './SchedulerWithCache';
export interface ISchedulerTranslateOptions {
    /**
     * Identifier to grouping requests
     */
    context?: string;
    /**
     * Priority index for translate queue
     */
    priority?: number;
    /**
     * Use direct translate for this request if it possible
     */
    directTranslate?: boolean;
}
export interface IScheduler {
    /**
     * Translate text
     *
     * @param text text for translation
     * @param from text language code
     * @param to target language code for translation
     * @param options {ISchedulerTranslateOptions}
     */
    translate(text: string, from: string, to: string, options?: ISchedulerTranslateOptions): Promise<string>;
    /**
     * Abort translation for all requests with provided context
     * - All delayed requests will be immediately rejected
     * - If exception thrown for in-flight requests, they will be rejected immediately with no retries
     *
     * @param context unique name for group of requests that must be aborted
     */
    abort(context: string): Promise<void>;
}