@univerjs/core - npm Package Compare versions

Comparing version 0.6.0-nightly.202502181606 to 0.6.0-nightly.202502191606

lib/es/facade.js

@@ -561,6 +561,8 @@ var A = Object.defineProperty;
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
    *   const { unitId, type, doc, unit } = params;
    *   console.log('doc created', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -576,6 +578,8 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
    *   const { unitId, unitType, snapshot } = params;
    *   console.log('doc disposed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -591,6 +595,8 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
    *   const { stage } = params;
    *   console.log('life cycle changed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -606,6 +612,8 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
    *   const { params, id, type } = event;
    *   console.log('redo command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -621,6 +629,8 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
    *   const { params, id, type } = event;
    *   console.log('undo command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -636,6 +646,11 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
    *   const { params, id, type } = event;
    *   console.log('before redo command executed', event);
+   *
+   *   // Cancel the redo operation
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -651,6 +666,11 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
    *   const { params, id, type } = event;
    *   console.log('before undo command executed', event);
+   *
+   *   // Cancel the undo operation
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -666,6 +686,8 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
    *   const { params, id, type } = event;
    *   console.log('command executed', event);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -681,6 +703,11 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
+   * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
    *   const { params, id, type } = event;
    *   console.log('before command executed', event);
+   *
+   *   // Cancel the command execution
+   *   event.cancel = true;
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -1246,6 +1273,9 @@ */
    * ```ts
-   * univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+   * // Add life cycle changed event listener
+   * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
    *   const { stage } = params;
    *   console.log('life cycle changed', params);
    * });
+   *
+   * // Remove the event listener, use `disposable.dispose()`
    * ```
@@ -1252,0 +1282,0 @@ */

lib/types/facade/f-event.d.ts

@@ -81,6 +81,8 @@ import { CommandType, IDocumentData, LifecycleStages, UniverInstanceType } from '@univerjs/core';
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
      *   const { unitId, type, doc, unit } = params;
      *   console.log('doc created', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -94,6 +96,8 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
      *   const { unitId, unitType, snapshot } = params;
      *   console.log('doc disposed', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -107,6 +111,8 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
      *   const { stage } = params;
      *   console.log('life cycle changed', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -120,6 +126,8 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
      *   const { params, id, type } = event;
      *   console.log('redo command executed', event);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -133,6 +141,8 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
      *   const { params, id, type } = event;
      *   console.log('undo command executed', event);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -146,6 +156,11 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
      *   const { params, id, type } = event;
      *   console.log('before redo command executed', event);
+     *
+     *   // Cancel the redo operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -159,6 +174,11 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
      *   const { params, id, type } = event;
      *   console.log('before undo command executed', event);
+     *
+     *   // Cancel the undo operation
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -172,6 +192,8 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
      *   const { params, id, type } = event;
      *   console.log('command executed', event);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -185,6 +207,11 @@ */
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
      *   const { params, id, type } = event;
      *   console.log('before command executed', event);
+     *
+     *   // Cancel the command execution
+     *   event.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -191,0 +218,0 @@ */

lib/types/facade/f-univer.d.ts

@@ -161,6 +161,9 @@ import { CommandListener, IDisposable, IDocumentData, IExecutionOptions, IParagraphStyle, ITextDecoration, ITextStyle, LifecycleStages, ColorBuilder, Disposable, ICommandService, Injector, IUniverInstanceService, LifecycleService, ParagraphStyleBuilder, ParagraphStyleValue, RichTextBuilder, RichTextValue, TextDecorationBuilder, TextStyleBuilder, TextStyleValue, Univer } from '@univerjs/core';
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
+     * // Add life cycle changed event listener
+     * const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
      *   const { stage } = params;
      *   console.log('life cycle changed', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
@@ -167,0 +170,0 @@ */

package.json

 {
   "name": "@univerjs/core",
-  "version": "0.6.0-nightly.202502181606",
+  "version": "0.6.0-nightly.202502191606",
   "private": false,
@@ -5,0 +5,0 @@ "description": "Core library for Univer.",

No alert changes

Improved metrics

Total package byte prevSize

1861399

increased by0.12%

Lines of code

34219

increased by0.18%

No dependency changes