@univerjs/engine-formula 1.0.0-rc.0 → 1.0.0

package/lib/facade.js

@@ -2,7 +2,7 @@ import { FBase, FUniver } from "@univerjs/core/facade";
 import { ICommandService, IConfigService, Inject, Injector } from "@univerjs/core";
 import { ENGINE_FORMULA_CYCLE_REFERENCE_COUNT, ENGINE_FORMULA_RETURN_DEPENDENCY_TREE, FormulaCalculationSessionService, IDefinedNamesService, IFunctionService, ISuperTableService, LexerTreeBuilder, SetCellFormulaDependencyCalculationMutation, SetCellFormulaDependencyCalculationResultMutation, SetFormulaCalculationNotificationMutation, SetFormulaCalculationStartMutation, SetFormulaCalculationStopMutation, SetFormulaDependencyCalculationMutation, SetFormulaDependencyCalculationResultMutation, SetFormulaStringBatchCalculationMutation, SetFormulaStringBatchCalculationResultMutation, SetQueryFormulaDependencyAllMutation, SetQueryFormulaDependencyAllResultMutation, SetQueryFormulaDependencyMutation, SetQueryFormulaDependencyResultMutation, SetTriggerFormulaCalculationStartMutation } from "@univerjs/engine-formula";
 
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorateParam.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
@@ -10,7 +10,7 @@ function __decorateParam(paramIndex, decorator) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.140.0/helpers/esm/decorate.js
+//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -151,6 +151,8 @@ let FFormula = class FFormula extends FBase {
 	}
 	/**
 	* Listens for formula results after every affected model has applied them.
+	* @param {(result: ISetFormulaCalculationResultMutation) => void} callback Receives each applied formula result asynchronously.
+	* @returns {IDisposable} A disposable that unsubscribes from future result notifications.
 	*/
 	calculationResultApplied(callback) {
 		const subscription = this._injector.get(FormulaCalculationSessionService).resultApplied$.subscribe((result) => {
@@ -164,6 +166,8 @@ let FFormula = class FFormula extends FBase {
 	}
 	/**
 	* Waits until the latest formula-calculation results have been applied.
+	* @param {number} [timeout] Maximum wait in milliseconds. Omit to wait without an overall timeout.
+	* @returns {Promise<void>} Resolves when the latest calculation results have been applied; rejects if the supplied timeout expires.
 	*/
 	onCalculationResultApplied(timeout) {
 		return this._injector.get(FormulaCalculationSessionService).waitForLatestApplied(timeout);