@types/office-js 1.0.299 → 1.0.301

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Fri, 11 Nov 2022 19:32:52 GMT
+ * Last updated: Thu, 01 Dec 2022 20:32:58 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -13143,7 +13143,7 @@ declare namespace Office {
      * The `InternetHeaders` object represents custom internet headers that are preserved after the message item leaves Exchange
      * and is converted to a MIME message. These headers are stored as x-headers in the MIME message.
      *
-     * Internet headers are stored as key/value pairs on a per-item basis.
+     * Internet headers are stored as string key-value pairs on a per-item basis.
      *
      * **Note**: This object is intended for you to set and get your custom headers on a message item. To learn more, see
      * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/internet-headers | Get and set internet headers on a message in an Outlook add-in}.
@@ -13173,8 +13173,8 @@ declare namespace Office {
      */
     interface InternetHeaders {
         /**
-         * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
-         * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
+         * Given an array of internet header names, this method returns a record containing those internet headers and their values.
+         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -13188,13 +13188,14 @@ declare namespace Office {
          * @param names - The names of the internet headers to be returned.
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
-         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
+         *                `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        getAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
         /**
-         * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values.
-         * If the add-in requests an x-header that is not available, that x-header will not be returned in the results.
+         * Given an array of internet header names, this method returns a record containing those internet headers and their values.
+         * If the add-in requests an x-header that isn't available, that x-header will not be returned in the results.
          *
          * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method.
          *
@@ -13206,10 +13207,11 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
          * @param names - The names of the internet headers to be returned.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
-         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
+         *                `asyncResult.value` property. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;
         /**
          * Given an array of internet header names, this method removes the specified headers from the internet header collection.
          *
@@ -13226,9 +13228,9 @@ declare namespace Office {
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
-         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         *                `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Given an array of internet header names, this method removes the specified headers from the internet header collection.
          *
@@ -13243,9 +13245,9 @@ declare namespace Office {
          *
          * @param names - The names of the internet headers to be removed.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
-         *                `asyncResult`, which is an `Office.AsyncResult` object.
+         *                `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;
+        removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Sets the specified internet headers to the specified values.
          *
@@ -13267,14 +13269,14 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
-         * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
-         *                internet headers and values being the values of the internet headers.
+         * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
+         *                and values being the corresponding header value strings.
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                 `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        setAsync(headers: Object, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
         /**
          * Sets the specified internet headers to the specified values.
          *
@@ -13296,12 +13298,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
          *
-         * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
-         *                internet headers and values being the values of the internet headers.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
+         * @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
+         *                and values being the corresponding header value strings.
+         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
+         *                 `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
          */
-        setAsync(headers: Object, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
+        setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
     }
     /**
      * The item namespace is used to access the currently selected message, meeting request, or appointment.
@@ -33146,7 +33148,8 @@ declare namespace Excel {
          */
         readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
         /**
-         * Represents the value computed by the name's formula. For a named range, will return the range address.
+         * Represents the value computed by the name's formula. For a named range it will return the range address.
+         * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
          *
          * @remarks
          * [Api set: ExcelApi 1.1]
@@ -66001,7 +66004,8 @@ declare namespace Excel {
              */
             type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
             /**
-             * Represents the value computed by the name's formula. For a named range, will return the range address.
+             * Represents the value computed by the name's formula. For a named range it will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -72977,7 +72981,8 @@ declare namespace Excel {
              */
             type?: boolean;
             /**
-             * For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range, will return the range address.
+             * For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range it will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -73078,7 +73083,8 @@ declare namespace Excel {
              */
             type?: boolean;
             /**
-             * Represents the value computed by the name's formula. For a named range, will return the range address.
+             * Represents the value computed by the name's formula. For a named range it will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.299",
+    "version": "1.0.301",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "af35f7fe51ae4ef1c1948f5d44cc584c5305712568ce41bd7eebf1be30b2a158",
-    "typeScriptVersion": "4.1"
+    "typesPublisherContentHash": "425acbc171bfcb4d003f13a927956c740bf1ffd92bd3ee83d98996a0baf557b4",
+    "typeScriptVersion": "4.2"
 }