@types/office-js-preview 1.0.687 → 1.0.688

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Mon, 23 Feb 2026 19:24:54 GMT
+ * Last updated: Tue, 24 Feb 2026 16:50:23 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -7922,17 +7922,17 @@ declare namespace Office {
      */
     interface Settings {
         /**
-         * Adds an event handler for the settingsChanged event.
+         * Adds an event handler for the `settingsChanged` event.
          *
-         * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+         * **Important**: Your add-in's code can register a handler for the `settingsChanged` event when the add-in is running with any Excel client, but
          * the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel on the web, and more than one user is editing the
-         * spreadsheet (coauthoring). Therefore, effectively the settingsChanged event is supported only in Excel on the web in coauthoring scenarios.
+         * spreadsheet (coauthoring). Therefore, effectively the `settingsChanged` event is supported only in Excel on the web in coauthoring scenarios.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
          *
-         * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
+         * You can add multiple event handlers for the specified `eventType` as long as the name of each event handler function is unique.
          *
          * @param eventType Specifies the type of event to add. Required.
          * @param handler The event handler function to add, whose only parameter is of type {@link Office.SettingsChangedEventArgs}. Required.
@@ -7954,27 +7954,27 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          */
         addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
         /**
-         * Adds an event handler for the settingsChanged event.
+         * Adds an event handler for the `settingsChanged` event.
          *
-         * **Important**: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but
+         * **Important**: Your add-in's code can register a handler for the `settingsChanged` event when the add-in is running with any Excel client, but
          * the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel on the web, and more than one user is editing the
-         * spreadsheet (coauthoring). Therefore, effectively the settingsChanged event is supported only in Excel on the web in coauthoring scenarios.
+         * spreadsheet (coauthoring). Therefore, effectively the `settingsChanged` event is supported only in Excel on the web in coauthoring scenarios.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
          *
-         * You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
+         * You can add multiple event handlers for the specified `eventType` as long as the name of each event handler function is unique.
          *
          * @param eventType Specifies the type of event to add. Required.
          * @param handler The event handler function to add, whose only parameter is of type {@link Office.SettingsChangedEventArgs}. Required.
@@ -7995,11 +7995,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          */
@@ -8025,10 +8025,10 @@ declare namespace Office {
          * This method is useful in Excel, Word, and PowerPoint coauthoring scenarios when multiple instances of the same add-in are working against
          * the same document. Because each add-in is working against an in-memory copy of the settings loaded from the document at the time the user
          * opened it, the settings values used by each user can get out of sync. This can happen whenever an instance of the add-in calls the
-         * Settings.saveAsync method to persist all of that user's settings to the document. Calling the refreshAsync method from the event handler
-         * for the settingsChanged event of the add-in will refresh the settings values for all users.
+         * `Settings.saveAsync` method to persist all of that user's settings to the document. Calling the `refreshAsync` method from the event handler
+         * for the `settingsChanged` event of the add-in will refresh the settings values for all users.
          *
-         * In the callback function passed to the refreshAsync method, you can use the properties of the AsyncResult object to return the following
+         * In the callback function passed to the `refreshAsync` method, you can use the properties of the `AsyncResult` object to return the following
          * information.
          *
          * <table>
@@ -8038,7 +8038,7 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.value</code></td>
-         *     <td>Access a Settings object with the refreshed values.</td>
+         *     <td>Access a <code>Settings</code> object with the refreshed values.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.status</code></td>
@@ -8046,11 +8046,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          *
@@ -8061,33 +8061,33 @@ declare namespace Office {
         /**
          * Removes the specified setting.
          *
-         * **Important**: Be aware that the Settings.remove method affects only the in-memory copy of the settings property bag. To persist the removal of
-         * the specified setting in the document, at some point after calling the Settings.remove method and before the add-in is closed, you must
-         * call the Settings.saveAsync method.
+         * **Important**: Be aware that the `Settings.remove` method affects only the in-memory copy of the settings property bag. To persist the removal of
+         * the specified setting in the document, at some point after calling the `Settings.remove` method and before the add-in is closed, you must
+         * call the `Settings.saveAsync` method.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
          *
-         * null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.
+         * `null` is a valid value for a setting. Therefore, assigning `null` to the setting will not remove it from the settings property bag.
          *
          * @param settingName The case-sensitive name of the setting to remove.
          */
         remove(name: string): void;
         /**
-         * Removes an event handler for the settingsChanged event.
+         * Removes an event handler for the `settingsChanged` event.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
          *
-         * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
+         * If the optional handler parameter is omitted when calling the `removeHandlerAsync` method, all event handlers for the specified `eventType`
          * will be removed.
          *
-         * When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback
+         * When the function you passed to the callback parameter executes, it receives an `AsyncResult` object that you can access from the callback
          * function's only parameter.
          *
-         * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the
+         * In the callback function passed to the `removeHandlerAsync` method, you can use the properties of the `AsyncResult` object to return the
          * following information.
          *
          * <table>
@@ -8105,11 +8105,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          *
@@ -8119,19 +8119,19 @@ declare namespace Office {
          */
         removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;
         /**
-         * Removes an event handler for the settingsChanged event.
+         * Removes an event handler for the `settingsChanged` event.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#methods-that-arent-part-of-a-requirement-set | Not in a set}
          *
-         * If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType
+         * If the optional handler parameter is omitted when calling the `removeHandlerAsync` method, all event handlers for the specified `eventType`
          * will be removed.
          *
-         * When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback
+         * When the function you passed to the callback parameter executes, it receives an `AsyncResult` object that you can access from the callback
          * function's only parameter.
          *
-         * In the callback function passed to the removeHandlerAsync method, you can use the properties of the AsyncResult object to return the
+         * In the callback function passed to the `removeHandlerAsync` method, you can use the properties of the `AsyncResult` object to return the
          * following information.
          *
          * <table>
@@ -8149,11 +8149,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          *
@@ -8169,11 +8169,11 @@ declare namespace Office {
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
          *
          * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the
-         * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
-         * available the next time the add-in is used, use the saveAsync method.
+         * `set` and `get` methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
+         * available the next time the add-in is used, use the `saveAsync` method.
          *
-         * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
-         * itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
+         * **Note**: The `saveAsync` method persists the in-memory settings property bag into the document file. However, the changes to the document file
+         * itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The `refreshAsync` method is only useful
          * in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
          * all instances.
          *
@@ -8192,11 +8192,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          *
@@ -8212,11 +8212,11 @@ declare namespace Office {
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
          *
          * Any settings previously saved by an add-in are loaded when it is initialized, so during the lifetime of the session you can just use the
-         * set and get methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
-         * available the next time the add-in is used, use the saveAsync method.
+         * `set` and `get` methods to work with the in-memory copy of the settings property bag. When you want to persist the settings so that they are
+         * available the next time the add-in is used, use the `saveAsync` method.
          *
-         * **Note**: The saveAsync method persists the in-memory settings property bag into the document file. However, the changes to the document file
-         * itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The refreshAsync method is only useful
+         * **Note**: The `saveAsync` method persists the in-memory settings property bag into the document file. However, the changes to the document file
+         * itself are saved only when the user (or AutoRecover setting) saves the document to the file system. The `refreshAsync` method is only useful
          * in coauthoring scenarios when other instances of the same add-in might change the settings and those changes should be made available to
          * all instances.
          *
@@ -8235,11 +8235,11 @@ declare namespace Office {
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.error</code></td>
-         *     <td>Access an Error object that provides error information if the operation failed.</td>
+         *     <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
          *   </tr>
          *   <tr>
          *     <td><code>AsyncResult.asyncContext</code></td>
-         *     <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
+         *     <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
          *   </tr>
          * </table>
          *
@@ -8249,17 +8249,17 @@ declare namespace Office {
         /**
          * Sets or creates the specified setting.
          *
-         * **Important**: Be aware that the Settings.set method affects only the in-memory copy of the settings property bag.
+         * **Important**: Be aware that the `Settings.set` method affects only the in-memory copy of the settings property bag.
          * To make sure that additions or changes to settings will be available to your add-in the next time the document is opened, at some point
-         * after calling the Settings.set method and before the add-in is closed, you must call the Settings.saveAsync method to persist settings in
+         * after calling the `Settings.set` method and before the add-in is closed, you must call the `Settings.saveAsync` method to persist settings in
          * the document.
          *
          * @remarks
          *
          * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#settings | Settings}
          *
-         * The set method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name
-         * in the in-memory copy of the settings property bag. After you call the Settings.saveAsync method, the value is stored in the document as
+         * The `set` method creates a new setting of the specified name if it does not already exist, or sets an existing setting of the specified name
+         * in the in-memory copy of the settings property bag. After you call the `Settings.saveAsync` method, the value is stored in the document as
          * the serialized JSON representation of its data type.
          *
          * @param settingName The case-sensitive name of the setting to set or create.

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.687",
+    "version": "1.0.688",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -46,7 +46,7 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "c0dc5a735033bc99f54e4f115285b9c86a1f3b07e9391062503e1d98b4ad8d92",
+    "typesPublisherContentHash": "84e84345547544d85adf26a016e31aba743332b3c1ca822e36948e0d77009afe",
     "typeScriptVersion": "5.2",
     "nonNpm": true
 }