@types/office-js 1.0.360 → 1.0.362

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 16 Nov 2023 22:35:34 GMT
11
+ * Last updated: Tue, 12 Dec 2023 18:35:46 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -111,7 +111,7 @@ declare namespace Office {
111
111
  * @param values An array of Promises.
112
112
  * @returns A new Promise.
113
113
  */
114
- all<T>(values: (T | PromiseLike<T>)[]): Promise<T[]>;
114
+ all<T>(values: Array<T | PromiseLike<T>>): Promise<T[]>;
115
115
 
116
116
  /**
117
117
  * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
@@ -191,7 +191,7 @@ declare namespace Office {
191
191
  * @param values An array of Promises.
192
192
  * @returns A new Promise.
193
193
  */
194
- race<T>(values: (T | PromiseLike<T>)[]): Promise<T>;
194
+ race<T>(values: Array<T | PromiseLike<T>>): Promise<T>;
195
195
 
196
196
  /**
197
197
  * Creates a new rejected promise for the provided reason.
@@ -572,7 +572,7 @@ declare namespace Office {
572
572
  * @param shortcuts An array of shortcut combinations. For example, `["Ctrl+1", "Ctrl+2"]`.
573
573
  * @returns A promise that resolves to an array of objects. Each object consists of a shortcut combination and Boolean value. The value is `true` if the shortcut combination conflicts with a shortcut of another add-in or with a shortcut of the Office application; otherwise, `false`. For example, `[{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}]`.
574
574
  */
575
- areShortcutsInUse(shortcuts: string[]): Promise<{shortcut: string, inUse: boolean}[]>;
575
+ areShortcutsInUse(shortcuts: string[]): Promise<Array<{shortcut: string, inUse: boolean}>>;
576
576
  }
577
577
  /**
578
578
  * Message used in the `onVisibilityModeChanged` invocation.
@@ -5905,7 +5905,7 @@ declare namespace Office {
5905
5905
  * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
5906
5906
  * The `value` property of the result is an array containing one or more JavaScript objects specifying the formatting of their corresponding cells.
5907
5907
  */
5908
- getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
5908
+ getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;
5909
5909
  /**
5910
5910
  * Gets the formatting on specified items in the table.
5911
5911
  *
@@ -5958,7 +5958,7 @@ declare namespace Office {
5958
5958
  * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
5959
5959
  * The `value` property of the result is an array containing one or more JavaScript objects specifying the formatting of their corresponding cells.
5960
5960
  */
5961
- getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< ({ cells: any, format: any})[]>) => void): void;
5961
+ getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;
5962
5962
  /**
5963
5963
  * Sets formatting on specified items and data in the table.
5964
5964
  *
@@ -11661,7 +11661,7 @@ declare namespace Office {
11661
11661
  * </tr>
11662
11662
  * </table>
11663
11663
  */
11664
- getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
11664
+ getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
11665
11665
  /**
11666
11666
  * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
11667
11667
  *
@@ -11688,7 +11688,7 @@ declare namespace Office {
11688
11688
  *
11689
11689
  * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
11690
11690
  */
11691
- getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
11691
+ getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
11692
11692
  /**
11693
11693
  * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
11694
11694
  *
@@ -12618,7 +12618,8 @@ declare namespace Office {
12618
12618
  *
12619
12619
  * - In Outlook on the web, `setSignatureAsync` only works on messages.
12620
12620
  *
12621
- * - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
12621
+ * - This method is supported in Message Compose on Outlook on Android. Support for this method in Message Compose on Outlook on iOS is currently being
12622
+ * rolled out. For a sample scenario, see
12622
12623
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
12623
12624
  * To learn more about APIs supported in Outlook mobile, see
12624
12625
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -12657,7 +12658,8 @@ declare namespace Office {
12657
12658
  *
12658
12659
  * - In Outlook on the web, `setSignatureAsync` only works on messages.
12659
12660
  *
12660
- * - This method is supported in Message Compose on Outlook on Android and on iOS. For a sample scenario, see
12661
+ * - This method is supported in Message Compose on Outlook on Android. Support for this method in Message Compose on Outlook on iOS is currently being
12662
+ * rolled out. For a sample scenario, see
12661
12663
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based | Implement event-based activation in Outlook mobile add-ins}.
12662
12664
  * To learn more about APIs supported in Outlook mobile, see
12663
12665
  * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
@@ -15685,8 +15687,9 @@ declare namespace Office {
15685
15687
  *
15686
15688
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15687
15689
  *
15688
- * **Important**: This method is supported in Message Compose in Outlook on Android and on iOS. For more information on supported APIs in
15689
- * Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15690
+ * **Important**: This method is supported in Message Compose in Outlook on Android. Support for this method in Message Compose on Outlook on iOS is currently
15691
+ * being rolled out. For more information on supported APIs in Outlook mobile, see
15692
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15690
15693
  *
15691
15694
  * @param options - An object literal that contains one or more of the following properties:-
15692
15695
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -15714,8 +15717,9 @@ declare namespace Office {
15714
15717
  *
15715
15718
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15716
15719
  *
15717
- * **Important**: This method is supported in Message Compose on Outlook on Android and on iOS. For more information on supported APIs in
15718
- * Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15720
+ * **Important**: This method is supported in Message Compose in Outlook on Android. Support for this method in Message Compose on Outlook on iOS is currently
15721
+ * being rolled out. For more information on supported APIs in Outlook mobile, see
15722
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15719
15723
  *
15720
15724
  * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
15721
15725
  * `asyncResult`, which is an `Office.AsyncResult` object.
@@ -15824,8 +15828,9 @@ declare namespace Office {
15824
15828
  *
15825
15829
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15826
15830
  *
15827
- * **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
15828
- * Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15831
+ * **Important**: This method is supported in Outlook on Android. Support for this method in Outlook on iOS is currently being rolled out.
15832
+ * For more information on supported APIs in Outlook mobile, see
15833
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15829
15834
  *
15830
15835
  * @param options - An object literal that contains one or more of the following properties:-
15831
15836
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -15848,8 +15853,9 @@ declare namespace Office {
15848
15853
  *
15849
15854
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15850
15855
  *
15851
- * **Important**: This method is supported in Outlook on Android and on iOS. For more information on supported APIs in
15852
- * Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15856
+ * **Important**: This method is supported in Outlook on Android. Support for this method in Outlook on iOS is currently being rolled out.
15857
+ * For more information on supported APIs in Outlook mobile, see
15858
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15853
15859
  *
15854
15860
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15855
15861
  * type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
@@ -17123,7 +17129,7 @@ declare namespace Office {
17123
17129
  * </tr>
17124
17130
  * </table>
17125
17131
  */
17126
- getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
17132
+ getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
17127
17133
  /**
17128
17134
  * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
17129
17135
  *
@@ -17150,7 +17156,7 @@ declare namespace Office {
17150
17156
  *
17151
17157
  * @param name - The name of the `ItemHasKnownEntity` rule element that defines the filter to match.
17152
17158
  */
17153
- getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];
17159
+ getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
17154
17160
  /**
17155
17161
  * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
17156
17162
  *
@@ -17788,7 +17794,7 @@ declare namespace Office {
17788
17794
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
17789
17795
  * of type `Office.AsyncResult`. If adding the recipients fails, the `asyncResult.error` property will contain an error code.
17790
17796
  */
17791
- addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
17797
+ addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
17792
17798
  /**
17793
17799
  * Adds a recipient list to the existing recipients for an appointment or message.
17794
17800
  *
@@ -17820,7 +17826,7 @@ declare namespace Office {
17820
17826
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
17821
17827
  * of type `Office.AsyncResult`. If adding the recipients fails, the `asyncResult.error` property will contain an error code.
17822
17828
  */
17823
- addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
17829
+ addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
17824
17830
  /**
17825
17831
  * Gets a recipient list for an appointment or message.
17826
17832
  *
@@ -17945,7 +17951,7 @@ declare namespace Office {
17945
17951
  * type `Office.AsyncResult`. If setting the recipients fails the `asyncResult.error` property will contain a code that
17946
17952
  * indicates any error that occurred while adding the data.
17947
17953
  */
17948
- setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void): void;
17954
+ setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void): void;
17949
17955
  /**
17950
17956
  * Sets a recipient list for an appointment or message.
17951
17957
  *
@@ -17980,7 +17986,7 @@ declare namespace Office {
17980
17986
  * type `Office.AsyncResult`. If setting the recipients fails the `asyncResult.error` property will contain a code that
17981
17987
  * indicates any error that occurred while adding the data.
17982
17988
  */
17983
- setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (asyncResult: Office.AsyncResult<void>) => void): void;
17989
+ setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void): void;
17984
17990
  }
17985
17991
  /**
17986
17992
  * Provides change status of recipients fields when the `Office.EventType.RecipientsChanged` event is raised.
@@ -28276,7 +28282,7 @@ declare namespace Excel {
28276
28282
  * @remarks
28277
28283
  * [Api set: ExcelApi 1.12]
28278
28284
  */
28279
- selectedItems?: (string | PivotItem)[];
28285
+ selectedItems?: Array<string | PivotItem>;
28280
28286
  }
28281
28287
  /**
28282
28288
  * Configurable template for a value filter to apply to a PivotField.
@@ -33908,7 +33914,7 @@ declare namespace Excel {
33908
33914
  * @param key The key of the new setting.
33909
33915
  * @param value The value for the new setting.
33910
33916
  */
33911
- add(key: string, value: string | number | boolean | Date | Array<any> | any): Excel.Setting;
33917
+ add(key: string, value: string | number | boolean | Date | any[] | any): Excel.Setting;
33912
33918
  /**
33913
33919
  * Gets the number of settings in the collection.
33914
33920
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.360",
3
+ "version": "1.0.362",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "ae8de400d8568d32d4f6095186642c7c6e7c5190260d566f9b91e1d71e9a8e1d",
49
- "typeScriptVersion": "4.5"
48
+ "typesPublisherContentHash": "0659567fcc7f56a46c8c1783ccbed755e5a2faf22f459122e1458f2614e745c6",
49
+ "typeScriptVersion": "4.6"
50
50
  }