Edgewise API
    Preparing search index...

    Interface EdgewiseWorker

    The verbs, proxied to a worker. Same options and results as the main package.

    interface EdgewiseWorker {
        capabilities(): Promise<Capabilities>;
        cloneVoice(options: CloneVoiceOptions): Promise<ClonedVoice>;
        configure(options: Record<string, unknown>): Promise<void>;
        embed(options: EmbedOneOptions): Promise<EmbedResult>;
        embed(options: EmbedManyOptions): Promise<EmbedManyResult>;
        evaluate<Q extends Record<string, Question>>(
            options: EvaluateOptions<Q>,
        ): Promise<EvaluateResult<Q>>;
        evaluate<Q extends Record<string, Question>>(
            options: EvaluateManyOptions<Q>,
        ): Promise<EvaluateManyResult<Q>>;
        forecast(
            options: ForecastOptions & { series: SeriesInput },
        ): Promise<ForecastResult>;
        forecast(
            options: ForecastOptions & { series: SeriesInput[] },
        ): Promise<ForecastManyResult>;
        generate<T = unknown>(
            options: GenerateOptions<T>,
        ): Run<GenerateResult<T>, GenerateChunk<T>>;
        listVoices(model?: string): Promise<VoiceInfo[]>;
        memoryUsage(): Promise<MemoryUsage>;
        models(): Promise<string[]>;
        paint(options: PaintOptions): Run<PaintResult, PaintStep>;
        preload(
            models: string | string[],
            o?: { allowPreview?: boolean; onProgress?: (e: LoadEvent) => void },
        ): Promise<void>;
        speak(options: SpeakOptions): SpeakRun;
        terminate(): Promise<void>;
        unload(id?: string): Promise<void>;
    }
    Index
    • Apply configure() inside the worker.

      Parameters

      • options: Record<string, unknown>

      Returns Promise<void>

    • Parameters

      • Optionalmodel: string

      Returns Promise<VoiceInfo[]>

    • Model IDs registered in the worker.

      Returns Promise<string[]>

    • Parameters

      • models: string | string[]
      • Optionalo: { allowPreview?: boolean; onProgress?: (e: LoadEvent) => void }

      Returns Promise<void>

    • Stop the worker. Pending runs reject with AbortError. Resolves once the worker has stopped.

      Returns Promise<void>

    • Parameters

      • Optionalid: string

      Returns Promise<void>