// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/** inspector module types */
@@ -5708,7 +5709,7 @@ declare module "util" {
}
declare module "assert" {
- function internal(value: any, message?: string): void;
+ function internal(value: any, message?: string | Error): void;
namespace internal {
export class AssertionError implements Error {
name: string;
@@ -5717,34 +5718,30 @@ declare module "assert" {
expected: any;
operator: string;
generatedMessage: boolean;
+ code: 'ERR_ASSERTION';
constructor(options?: {
message?: string; actual?: any; expected?: any;
- operator?: string; stackStartFunction?: Function
+ operator?: string; stackStartFn?: Function
});
}
- export function fail(message: string): never;
- export function fail(actual: any, expected: any, message?: string, operator?: string): never;
- export function ok(value: any, message?: string): void;
- export function equal(actual: any, expected: any, message?: string): void;
- export function notEqual(actual: any, expected: any, message?: string): void;
- export function deepEqual(actual: any, expected: any, message?: string): void;
- export function notDeepEqual(acutal: any, expected: any, message?: string): void;
- export function strictEqual(actual: any, expected: any, message?: string): void;
- export function notStrictEqual(actual: any, expected: any, message?: string): void;
- export function deepStrictEqual(actual: any, expected: any, message?: string): void;
- export function notDeepStrictEqual(actual: any, expected: any, message?: string): void;
+ export function fail(message?: string | Error): never;
+ export function fail(actual: any, expected: any, message?: string | Error, operator?: string, stackStartFn?: Function): never;
+ export function ok(value: any, message?: string | Error): void;
+ export function equal(actual: any, expected: any, message?: string | Error): void;
+ export function notEqual(actual: any, expected: any, message?: string | Error): void;
+ export function deepEqual(actual: any, expected: any, message?: string | Error): void;
+ export function notDeepEqual(actual: any, expected: any, message?: string | Error): void;
+ export function strictEqual(actual: any, expected: any, message?: string | Error): void;
+ export function notStrictEqual(actual: any, expected: any, message?: string | Error): void;
+ export function deepStrictEqual(actual: any, expected: any, message?: string | Error): void;
+ export function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void;
- export function throws(block: Function, message?: string): void;
- export function throws(block: Function, error: Function, message?: string): void;
- export function throws(block: Function, error: RegExp, message?: string): void;
- export function throws(block: Function, error: (err: any) => boolean, message?: string): void;
-
- export function doesNotThrow(block: Function, message?: string): void;
- export function doesNotThrow(block: Function, error: Function, message?: string): void;
- export function doesNotThrow(block: Function, error: RegExp, message?: string): void;
- export function doesNotThrow(block: Function, error: (err: any) => boolean, message?: string): void;
+ export function throws(block: Function, message?: string | Error): void;
+ export function throws(block: Function, error: RegExp | Function, message?: string | Error): void;
+ export function doesNotThrow(block: Function, message?: string | Error): void;
+ export function doesNotThrow(block: Function, error: RegExp | Function, message?: string | Error): void;
export function ifError(value: any): void;
}
diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts
index f0adb92080..d24d35d469 100644
--- a/types/office-js/index.d.ts
+++ b/types/office-js/index.d.ts
@@ -239,6 +239,25 @@ declare namespace Office {
/**
* Gets the Context object that represents the runtime environment of the add-in and provides access to the top-level objects of the API.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
var context: Context;
/**
@@ -253,7 +272,23 @@ declare namespace Office {
* *Note*: The reason parameter of the initialize event listener function only returns an `InitializationReason` enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*
* @param reason Indicates how the app was initialized.
*/
@@ -269,7 +304,23 @@ declare namespace Office {
* Toggles on and off the `Office` alias for the full `Microsoft.Office.WebExtension` namespace.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*
* @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true.
*/
@@ -454,32 +505,96 @@ declare namespace Office {
* Gets the user-defined item passed to the optional `asyncContext` parameter of the invoked method in the same state as it was passed in. This returns the user-defined item (which can be of any JavaScript type: String, Number, Boolean, Object, Array, Null, or Undefined) passed to the optional `asyncContext` parameter of the invoked method. Returns Undefined, if you didn't pass anything to the asyncContext parameter.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | Y | | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
asyncContext: any;
/**
- * Gets the {@link Office.AsyncResultStatus} of the asynchronous operation.
- *
- * @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
- */
- status: AsyncResultStatus;
- /**
* Gets an {@link Office.Error} object that provides a description of the error, if any error occurred.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
error: Office.Error;
/**
+ * Gets the {@link Office.AsyncResultStatus} of the asynchronous operation.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
+ */
+ status: AsyncResultStatus;
+ /**
* Gets the payload or content of this asynchronous operation, if any.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
- *
* You access the AsyncResult object in the function passed as the argument to the callback parameter of an "Async" method, such as the `getSelectedDataAsync` and `setSelectedDataAsync` methods of the {@link Office.Document | Document} object.
*
- * Note: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method. To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.
+ * Note: What the value property returns for a particular "Async" method varies depending on the purpose and context of that method.
+ * To determine what is returned by the value property for an "Async" method, refer to the "Callback value" section of the method's topic.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
value: any;
}
@@ -503,6 +618,28 @@ declare namespace Office {
commerceAllowed: boolean;
/**
* Gets the locale (language) specified by the user for editing the document or item.
+ *
+ * @remarks
+ * The `contentLanguage` value reflects the **Editing Language** setting specified with **File > Options > Language** in the Office host application.
+ *
+ * In content add-ins for Access web apps, the `contentLanguage` property gets the add-in culture (e.g., "en-GB").
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
contentLanguage: string;
/**
@@ -513,11 +650,53 @@ declare namespace Office {
* Gets the locale (language) specified by the user for the UI of the Office host application.
*
* @remarks
+ *
+ * The returned value is a string in the RFC 1766 Language tag format, such as en-US.
+ *
+ * The `displayLanguage` value reflects the current **Display Language** setting specified with **File > Options > Language** in the Office host application.
+ *
+ * In content add-ins for Access web apps, the `displayLanguage property` gets the add-in language (e.g., "en-US").
+ *
* When using in Outlook, the applicable modes are Compose or read.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | Y | | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | | Y | | |
|---|
+ *
*/
displayLanguage: string;
/**
* Gets an object that represents the document the content or task pane add-in is interacting with.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Project | Y | | |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
document: Document;
/**
@@ -588,9 +767,24 @@ declare namespace Office {
* Provides specific information about an error that occurred during an asynchronous data operation.
*
* @remarks
- * | Hosts | Access, Excel, Outlook, PowerPoint, Project, Word |
- *
* The Error object is accessed from the AsyncResult object that is returned in the function passed as the callback argument of an asynchronous data operation, such as the setSelectedDataAsync method of the Document object.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad | OWA for Devices | Office for Mac |
|---|
+ * | Access | | Y | | | |
|---|
+ * | Excel | Y | Y | Y | | |
|---|
+ * | Outlook | Y | Y | | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y | | |
|---|
+ * | Project | Y | | | | |
|---|
+ * | Word | Y | Y | Y | | |
|---|
+ *
*/
interface Error {
/**
@@ -610,13 +804,9 @@ declare namespace Office {
/**
* The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. The object allows the add-in to identify which button was clicked and to signal the host that it has completed its processing.
*
- * [Api set: Mailbox 1.3]
- *
* @remarks
*
- * | Hosts | Excel, Outlook, PowerPoint, Word |
- *
- * | Add-in type | Content, task pane, Outlook |
+ * | Add-in type | Content, task pane, Outlook |
*
* | {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level} | Restricted |
*
@@ -625,10 +815,21 @@ declare namespace Office {
interface Event {
/**
- * Information about the control that triggered calling this function
+ * Information about the control that triggered calling this function.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Outlook | Y (Mailbox 1.3) | | |
|---|
+ *
*/
source:Source;
-
/**
* Indicates that the add-in has completed processing that was triggered by an add-in command button or event handler.
*
@@ -644,6 +845,21 @@ declare namespace Office {
*
* | {@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode} | Compose or read |
*
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Outlook | Y (Mailbox 1.3) | | |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ *
* @param options Optional. An object literal that contains one or more of the following properties.
* allowEvent: A boolean value. When the completed method is used to signal completion of an event handler, this value indicates of the handled event should continue execution or be canceled. For example, an add-in that handles the ItemSend event can set allowEvent = false to cancel sending of the message.
*/
@@ -1168,7 +1384,21 @@ declare namespace Office {
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with File > Office Account > Office Theme UI, which is applied across all Office host applications. Using Office theme colors is appropriate for mail and task pane add-ins.
*
* @remarks
- * | Hosts | Excel, Outlook, Powerpoint, Project, Word |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that these properties are supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop |
|---|
+ * | Excel | Y |
|---|
+ * | Outlook | Y |
|---|
+ * | PowerPoint | Y |
|---|
+ * | Word | Y |
|---|
+ *
*/
interface OfficeTheme {
/**
@@ -1216,6 +1446,22 @@ declare namespace Office {
* Returns a promise of an object described in the expression. Callback is invoked only if method fails.
* @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
function select(expression: string, callback?: (result: AsyncResult) => void): Binding;
// Enumerations
@@ -1451,18 +1697,62 @@ declare namespace Office {
enum EventType {
/**
* A Document.ActiveViewChanged event was raised.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ *
*/
ActiveViewChanged,
/**
* Occurs when data within the binding is changed.
* To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object.
* The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
BindingDataChanged,
/**
* Occurs when the selection is changed within the binding.
* To add an event handler for the BindingSelectionChanged event of a binding, use the addHandlerAsync method of the Binding object.
* The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
BindingSelectionChanged,
/**
@@ -1474,7 +1764,20 @@ declare namespace Office {
*/
DialogEventReceived,
/**
- * Triggers when a document level selection happens.
+ * Triggers when a document level selection happens
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this enumeration is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | | Y | |
|---|
+ * | Word | Y | Y | |
|---|
+ *
*/
DocumentSelectionChanged,
/**
@@ -1509,6 +1812,21 @@ declare namespace Office {
ResourceSelectionChanged,
/**
* A Settings.settingsChanged event was raised.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
SettingsChanged,
/**
@@ -1730,36 +2048,39 @@ declare namespace Office {
* Represents a binding to a section of the document.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBinding, TableBinding, TextBinding |
*
* The Binding object exposes the functionality possessed by all bindings regardless of type.
*
* The Binding object is never called directly. It is the abstract parent class of the objects that represent each type of binding: MatrixBinding, TableBinding, or TextBinding. All three of these objects inherit the getDataAsync and setDataAsync methods from the Binding object that enable to you interact with the data in the binding. They also inherit the id and type properties for querying those property values. Additionally, the MatrixBinding and TableBinding objects expose additional methods for matrix- and table-specific features, such as counting the number of rows and columns.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface Binding {
/**
* Get the Document object associated with the binding.
- *
- * @remarks
- *
*/
document: Document;
/**
* A string that uniquely identifies this binding among the bindings in the same Document object.
- *
- * @remarks
- *
*/
id: string;
/**
* Gets the type of the binding.
- *
- * @remarks
- *
*/
type: BindingType;
/**
@@ -1778,8 +2099,6 @@ declare namespace Office {
* Returns the data contained within the binding.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
*
* When called from a MatrixBinding or TableBinding, the getDataAsync method will return a subset of the bound values if the optional startRow, startColumn, rowCount, and columnCount parameters are specified (and they specify a contiguous and valid range).
@@ -1792,8 +2111,6 @@ declare namespace Office {
* Removes the specified handler from the binding for the specified event type.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | BindingEvents |
*
* @param eventType The event type. For bindings, it can be `Office.EventType.BindingDataChanged` or `Office.EventType.BindingSelectionChanged`.
@@ -1805,8 +2122,6 @@ declare namespace Office {
* Writes data to the bound section of the document represented by the specified binding object.
*
* @remarks
- *
- * | Hosts | Access, Excel, Word |
*
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
*
@@ -2000,24 +2315,32 @@ declare namespace Office {
/**
* Represents the bindings the add-in has within the document.
- *
- * @remarks
- *
*/
interface Bindings {
/**
- * Gets an {@link Office.Document} object that represents the document associated with this set of bindings.
- *
- * @remarks
- *
- */
+ * Gets an {@link Office.Document} object that represents the document associated with this set of bindings.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ */
document: Document;
/**
* Creates a binding against a named object in the document.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
*
* For Excel, the itemName parameter can refer to a named range or a table.
@@ -2032,6 +2355,19 @@ declare namespace Office {
*
* Note: In Word, if there are multiple Rich Text content controls with the same Title property value (name), and you try to bind to one these content controls with this method (by specifying its name as the itemName parameter), the operation will fail.
*
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
* @param itemName Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
* @param bindingType The {@link Office.BindingType} for the data. The method returns null if the selected object cannot be coerced into the specified type.
* @param options Provides options for configuring the binding that is created.
@@ -2042,11 +2378,22 @@ declare namespace Office {
* Create a binding by prompting the user to make a selection on the document.
*
* @remarks
- * | Hosts | Access, Excel |
- *
* | Requirement Sets | Not in a set |
*
* Adds a binding object of the specified type to the Bindings collection, which will be identified with the supplied id. The method fails if the specified selection cannot be bound.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ *
*
* @param bindingType Specifies the type of the binding object to create. Required. Returns null if the selected object cannot be coerced into the specified type.
* @param options Provides options for configuring the prompt and identifying the binding that is created.
@@ -2057,13 +2404,26 @@ declare namespace Office {
* Create a binding based on the user's current selection.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
*
* Adds the specified type of binding object to the Bindings collection, which will be identified with the supplied id.
*
- * Note In Excel, if you call the addFromSelectionAsync method passing in the Binding.id of an existing binding, the Binding.type of that binding is used, and its type cannot be changed by specifying a different value for the bindingType parameter.If you need to use an existing id and change the bindingType, call the Bindings.releaseByIdAsync method first to release the binding, and then call the addFromSelectionAsync method to reestablish the binding with a new type.
+ * Note In Excel, if you call the addFromSelectionAsync method passing in the Binding.id of an existing binding, the Binding.type of that binding is used, and its type cannot be changed by specifying a different value for the bindingType parameter.
+ * If you need to use an existing id and change the bindingType, call the Bindings.releaseByIdAsync method first to release the binding, and then call the addFromSelectionAsync method to reestablish the binding with a new type.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param bindingType Specifies the type of the binding object to create. Required. Returns null if the selected object cannot be coerced into the specified type.
* @param options Provides options for configuring the prompt and identifying the binding that is created.
@@ -2074,9 +2434,21 @@ declare namespace Office {
* Gets all bindings that were previously created.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2086,11 +2458,23 @@ declare namespace Office {
* Retrieves a binding based on its Name
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | CustomXmlParts, MatrixBindings, TableBindings, TextBindings |
*
* Fails if the specified id does not exist.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param id Specifies the unique name of the binding object. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2101,11 +2485,23 @@ declare namespace Office {
* Removes the binding from the document
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
* | Requirement Sets | MatrixBindings, TableBindings, TextBindings |
*
* Fails if the specified id does not exist.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param id Specifies the unique name to be used to identify the binding object. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2117,17 +2513,25 @@ declare namespace Office {
* Represents an XML node in a tree in a document.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
+ * | Requirement Sets | CustomXmlParts |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface CustomXmlNode {
/**
* Gets the base name of the node without the namespace prefix, if one exists.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*/
baseName: string;
@@ -2135,8 +2539,6 @@ declare namespace Office {
* Retrieves the string GUID of the CustomXMLPart.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*/
namespaceUri: string;
@@ -2144,8 +2546,6 @@ declare namespace Office {
* Gets the type of the CustomXMLNode.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*/
nodeType: string;
@@ -2153,8 +2553,6 @@ declare namespace Office {
* Gets the nodes associated with the XPath expression.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param xPath The XPath expression that specifies the nodes to get. Required.
@@ -2166,8 +2564,6 @@ declare namespace Office {
* Gets the node value.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2178,8 +2574,6 @@ declare namespace Office {
* Gets the text of an XML node in a custom XML part.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2190,8 +2584,6 @@ declare namespace Office {
* Gets the node's XML.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2202,8 +2594,6 @@ declare namespace Office {
* Sets the node value.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param value The value to be set on the node
@@ -2228,8 +2618,6 @@ declare namespace Office {
* Sets the node XML.
*
* @remarks
- * | Hosts | Word |
- *
* | Requirement Sets | CustomXmlParts |
*
* @param xml The XML to be set on the node
@@ -2242,36 +2630,31 @@ declare namespace Office {
* Represents a single CustomXMLPart in an {@link Office.CustomXmlParts} collection.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
+ * | Requirement Sets | CustomXmlParts |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface CustomXmlPart {
/**
* True, if the custom XML part is built in; otherwise false.
- *
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*/
builtIn: boolean;
/**
* Gets the GUID of the CustomXMLPart.
- *
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*/
id: string;
/**
* Gets the set of namespace prefix mappings ({@link Office.CustomXmlPrefixMappings}) used against the current CustomXMLPart.
- *
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*/
namespaceManager: CustomXmlPrefixMappings;
@@ -2279,7 +2662,6 @@ declare namespace Office {
* Adds an event handler to the object using the specified event type.
*
* @remarks
- *
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -2293,9 +2675,6 @@ declare namespace Office {
* Deletes the Custom XML Part.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2305,9 +2684,6 @@ declare namespace Office {
* Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* @param xPath An XPath expression that specifies the nodes you want returned. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -2318,9 +2694,6 @@ declare namespace Office {
* Asynchronously gets the XML inside this custom XML part.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2330,9 +2703,6 @@ declare namespace Office {
* Removes an event handler for the specified event type.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* @param eventType Specifies the type of event to remove. For a CustomXmlPart object, the eventType parameter can be specified as `Office.EventType.NodeDeleted`, `Office.EventType.NodeInserted`, and `Office.EventType.NodeReplaced`.
* @param handler The name of the handler to remove.
@@ -2346,7 +2716,18 @@ declare namespace Office {
* Provides information about the deleted node that raised the nodeDeleted event.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
interface NodeDeletedEventArgs {
/**
@@ -2369,7 +2750,18 @@ declare namespace Office {
* Provides information about the inserted node that raised the nodeInserted event.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
interface NodeInsertedEventArgs {
/**
@@ -2386,6 +2778,18 @@ declare namespace Office {
/**
* Provides information about the replaced node that raised the nodeReplaced event.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
interface NodeReplacedEventArgs {
/**
@@ -2410,19 +2814,24 @@ declare namespace Office {
* Represents a collection of CustomXmlPart objects.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
+ * | Requirement Sets | CustomXmlParts |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
interface CustomXmlParts {
/**
* Asynchronously adds a new custom XML part to a file.
*
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
- *
* @param xml The XML to add to the newly created custom XML part.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2431,11 +2840,6 @@ declare namespace Office {
/**
* Asynchronously gets the specified custom XML part by its id.
*
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
- *
* @param id The GUID of the custom XML part, including opening and closing braces.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2444,11 +2848,6 @@ declare namespace Office {
/**
* Asynchronously gets the specified custom XML part(s) by its namespace.
*
- * @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
- *
* @param ns The namespace URI.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2459,17 +2858,26 @@ declare namespace Office {
* Represents a collection of CustomXmlPart objects.
*
* @remarks
- *
+ *
+ * | Requirement Sets | CustomXmlParts |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
interface CustomXmlPrefixMappings {
/**
* Asynchronously adds a prefix to namespace mapping to use when querying an item.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
- *
* If no namespace is assigned to the requested prefix, the method returns an empty string ("").
*
* @param prefix Specifies the prefix to add to the prefix mapping list. Required.
@@ -2482,9 +2890,6 @@ declare namespace Office {
* Asynchronously gets the namespace mapped to the specified prefix.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one added or used by the data store internally, in which case it will return an error.
*
@@ -2497,9 +2902,6 @@ declare namespace Office {
* Asynchronously gets the prefix for the specified namespace.
*
* @remarks
- * | Hosts | Word |
- *
- * | Requirement Sets | CustomXmlParts |
*
* If no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in the namespace manager, the method returns the first prefix that matches the supplied namespace.
*
@@ -2520,48 +2922,126 @@ declare namespace Office {
* Gets an object that provides access to the bindings defined in the document.
*
* @remarks
- *
- *
* You don't instantiate the Document object directly in your script. To call members of the Document object to interact with the current document or worksheet, use `Office.context.document` in your script.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
bindings: Bindings;
/**
* Gets an object that represents the custom XML parts in the document.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*/
customXmlParts: CustomXmlParts;
/**
* Gets the mode the document is in.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
mode: DocumentMode;
/**
* Gets an object that represents the saved custom settings of the content or task pane add-in for the current document.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
settings: Settings;
/**
* Gets the URL of the document that the host application currently has open. Returns null if the URL is unavailable.
*
* @remarks
- *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | | |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
url: string;
/**
* Adds an event handler for a Document object event.
*
* @remarks
- * | Hosts | Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | DocumentEvents |
+ * | Requirement Sets | DocumentEvents |
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Project | Y | | |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param eventType For a Document object event, the eventType parameter can be specified as `Office.EventType.Document.SelectionChanged` or `Office.EventType.Document.ActiveViewChanged`, or the corresponding text value of this enumeration.
* @param handler The event handler function to add, whose only parameter is of type {@link Office.DocumentSelectionChangedEventArgs}. Required.
@@ -2573,11 +3053,23 @@ declare namespace Office {
* Returns the state of the current view of the presentation (edit or read).
*
* @remarks
- * | Hosts | Excel, PowerPoint, Word |
- *
- * | Requirement Sets | ActiveView |
+ * | Requirement Sets | ActiveView |
*
* Can trigger an event when the view changes.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | | | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | | | Y |
|---|
+ *
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2587,9 +3079,7 @@ declare namespace Office {
* Returns the entire document file in slices of up to 4194304 bytes (4 MB). For add-ins for iOS, file slice is supported up to 65536 (64 KB). Note that specifying file slice size of above permitted limit will result in an "Internal Error" failure.
*
* @remarks
- * | Hosts | Excel, PowerPoint, Word |
- *
- * | Requirement Sets | File |
+ *
*
* For add-ins running in Office host applications other than Office for iOS, the getFileAsync method supports getting files in slices of up to 4194304 bytes (4 MB). For add-ins running in Office for iOS apps, the getFileAsync method supports getting files in slices of up to 65536 (64 KB).
*
@@ -2602,6 +3092,20 @@ declare namespace Office {
* Word on Windows desktop, Word on Mac, and Word Online: `Office.FileType.Compressed`, `Office.FileType.Pdf`, `Office.FileType.Text`
*
* Word on iPad: `Office.FileType.Compressed`, `Office.FileType.Text`
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | | |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*
* @param fileType The format in which the file will be returned
* @param options Provides options for setting the size of slices that the document will be divided into.
@@ -2612,11 +3116,23 @@ declare namespace Office {
* Gets file properties of the current document.
*
* @remarks
- * | Hosts | Excel, PowerPoint, Word |
- *
- * | Requirement Sets | not in a set |
+ * | Requirement Sets | Not in a set |
*
* You get the file's URL with the url property `asyncResult.value.url`.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -2626,9 +3142,7 @@ declare namespace Office {
* Reads the data contained in the current selection in the document.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | Selection |
+ * | Requirement Sets | Selection |
*
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return the following information.
*
@@ -2688,6 +3202,22 @@ declare namespace Office {
*
*
*
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Project | Y | Y | |
|---|
+ * | Word | Y | | Y |
|---|
+ *
+ *
* @param coercionType The type of data structure to return. See the remarks section for each host's supported coercion types.
*
* @param options Provides options for customizing what data is returned and how it is formatted.
@@ -2699,9 +3229,7 @@ declare namespace Office {
* Goes to the specified object or location in the document.
*
* @remarks
- * | Hosts | Excel, PowerPoint, Word |
- *
- * | Requirement Sets | not in a set |
+ * | Requirement Sets | not in a set |
*
* PowerPoint doesn't support the goToByIdAsync method in Master Views.
*
@@ -2712,6 +3240,20 @@ declare namespace Office {
* In PowerPoint: `Office.SelectionMode.Selected` selects the slide title or first textbox on the slide. `Office.SelectionMode.None` Doesn't select anything.
*
* In Word: `Office.SelectionMode.Selected` selects all content in the binding. Office.SelectionMode.None for text bindings, moves the cursor to the beginning of the text; for matrix bindings and table bindings, selects the first data cell (not first cell in header row for tables).
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*
* @param id The identifier of the object or location to go to.
* @param goToType The type of the location to go to.
@@ -2723,9 +3265,21 @@ declare namespace Office {
* Removes an event handler for the specified event type.
*
* @remarks
- * | Hosts | Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | DocumentEvents |
+ * | Requirement Sets | DocumentEvents |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param eventType The event type. For document can be 'Document.SelectionChanged' or 'Document.ActiveViewChanged'.
* @param options Provides options to determine which event handler or handlers are removed.
@@ -2736,9 +3290,7 @@ declare namespace Office {
* Writes the specified data into the current selection.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word, Word Online |
- *
- * | Requirement Sets | Selection |
+ * | Requirement Sets | Selection |
*
* **Application-specific behaviors**
*
@@ -2800,6 +3352,21 @@ declare namespace Office {
*
*
*
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | y | | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ *
* @param data The data to be set. Either a string or {@link Office.CoercionType} value, 2d array or TableData object.
*
* If the value passed for `data` is:
@@ -2823,6 +3390,20 @@ declare namespace Office {
* @param fieldId Project level fields.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2831,24 +3412,80 @@ declare namespace Office {
* @param fieldId Resource Fields.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
* Project documents only. Get the current selected Resource's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
* Project documents only. Get the current selected Task's Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
* Project documents only. Get the current selected View Type (Ex. Gantt) and View Name.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2856,6 +3493,20 @@ declare namespace Office {
* @param taskId Either a string or value of the Task Id.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2864,12 +3515,40 @@ declare namespace Office {
* @param fieldId Task Fields.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
* Project documents only. Get the WSS Url and list name for the Tasks List, the MPP is synced too.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2879,6 +3558,20 @@ declare namespace Office {
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2888,6 +3581,20 @@ declare namespace Office {
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2898,6 +3605,20 @@ declare namespace Office {
* @param resourceIndex The index of the resource in the collection of resources for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2908,6 +3629,20 @@ declare namespace Office {
* @param taskIndex The index of the task in the collection of tasks for the project.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2920,6 +3655,20 @@ declare namespace Office {
* @param fieldValue Value of the target field.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
@@ -2932,6 +3681,20 @@ declare namespace Office {
* @param fieldValue Value of the target field.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ *
+ * @remarks
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) |
|---|
+ * | Project | Y | |
|---|
+ *
*/
setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
}
@@ -2952,24 +3715,31 @@ declare namespace Office {
* Represents the document file associated with an Office Add-in.
*
* @remarks
- *
- *
* Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface File {
/**
* Gets the document file size in bytes.
*
* @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
+ *
*/
size: number;
/**
* Gets the number of slices into which the file is divided.
- * @remarks
- *
*/
sliceCount: number;
/**
@@ -2977,9 +3747,7 @@ declare namespace Office {
*
* @remarks
*
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
+ *
*
* No more than two documents are allowed to be in memory; otherwise the Document.getFileAsync operation will fail. Use the File.closeAsync method to close the file when you are finished working with it.
*
@@ -3015,9 +3783,7 @@ declare namespace Office {
* Returns the specified slice.
*
* @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
+ *
*
* In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following information.
*
@@ -3059,11 +3825,22 @@ declare namespace Office {
* Represents a binding in two dimensions of rows and columns.
*
* @remarks
- * | Hosts | Excel, Word |
- *
- * | Requirement Sets | MatrixBindings |
+ * | Requirement Sets | MatrixBindings |
*
* The MatrixBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface MatrixBinding extends Binding {
/**
@@ -3109,9 +3886,7 @@ declare namespace Office {
*
* @remarks
*
- * | Hosts | Excel |
- *
- * | Requirement Sets | Settings |
+ *
*
* You can add multiple event handlers for the specified eventType as long as the name of each event handler function is unique.
*
@@ -3142,15 +3917,40 @@ declare namespace Office {
* A user-defined item of any type that is returned in the AsyncResult object without being altered. |
*
*
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | | Y | |
|---|
+ *
*/
addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult) => void): void;
/**
* Retrieves the specified setting.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Word |
- *
- * | Requirement Sets | Settings |
+ *
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param settingName The case-sensitive name of the setting to retrieve.
* @returns An object that has property names mapped to JSON serialized values.
@@ -3161,9 +3961,7 @@ declare namespace Office {
*
* @remarks
*
- * | Hosts | Access, Excel, PowerPoint, Word |
- *
- * | Requirement Sets | Settings |
+ *
*
* 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.
@@ -3194,6 +3992,21 @@ declare namespace Office {
* A user-defined item of any type that is returned in the AsyncResult object without being altered. |
*
*
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. 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.
*/
@@ -3204,11 +4017,24 @@ declare namespace Office {
* 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
- * | Hosts | Access, Excel, PowerPoint, Word |
- *
- * | Requirement Sets | Settings |
+ *
*
* null is a valid value for a setting. Therefore, assigning null to the setting will not remove it from the settings property bag.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | | Y |
|---|
+ *
*
* @param settingName The case-sensitive name of the setting to remove.
*/
@@ -3217,26 +4043,38 @@ declare namespace Office {
* Removes an event handler for the settingsChanged event.
*
* @remarks
+ *
+ *
+ *
* If the optional handler parameter is omitted when calling the removeHandlerAsync method, all event handlers for the specified eventType will be removed.
- *
- * | Hosts | Access, Excel, PowerPoint |
- *
- * | Requirement Sets | Settings |
+ *
+ * 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 following information.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ *
*
* @param eventType Specifies the type of event to remove. Required.
* @param options Provides options to determine which event handler or handlers are removed.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
- * @remarks
- * 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 following information.
*/
removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult) => void): void;
/**
* Persists the in-memory copy of the settings property bag in the document.
*
- * @remarks
- * | Hosts | Access, Excel, PowerPoint, Word |
- *
+ * @remarks
* 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.
*
@@ -3266,6 +4104,21 @@ declare namespace Office {
*
*
*
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ *
* @param options Provides options for saving settings.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. 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 to return the following information.
*/
@@ -3277,12 +4130,26 @@ declare namespace Office {
* 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 the document.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Word |
- *
- * | Requirement Sets | 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 serialized JSON representation of its data type. A maximum of 2MB is available for the settings of each add-in.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ *
* @param settingName The case-sensitive name of the setting to set or create.
* @param value Specifies the value to be stored.
*/
@@ -3292,84 +4159,97 @@ declare namespace Office {
* Represents a slice of a document file.
*
* @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
+ *
*
* The Slice object is accessed with the File.getSliceAsync method.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | PowerPoint | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
interface Slice {
/**
* Gets the raw data of the file slice in `Office.FileType.Text` ("text") or `Office.FileType.Compressed` ("compressed") format as specified by the fileType parameter of the call to the Document.getFileAsync method.
*
* @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
*
* Files in the "compressed" format will return a byte array that can be transformed to a base64-encoded string if required.
*/
data: any;
/**
* Gets the zero-based index of the file slice.
- *
- * @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
*/
index: number;
/**
* Gets the size of the slice in bytes.
- *
- * @remarks
- * | Hosts | PowerPoint, Word |
- *
- * | Requirement Sets | File |
*/
size: number;
}
/**
- * Represents a binding in two dimensions of rows and columns, optionally with headers.
- *
- * @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | TableBindings |
- *
- * The TableBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object.
- *
- * For Excel, note that after you establish a table binding in Excel, each new row a user adds to the table is automatically included in the binding and rowCount increases.
- */
+ * Represents a binding in two dimensions of rows and columns, optionally with headers.
+ *
+ * @remarks
+ * | Requirement Sets | TableBindings |
+ *
+ * The TableBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Binding object.
+ *
+ * For Excel, note that after you establish a table binding in Excel, each new row a user adds to the table is automatically included in the binding and rowCount increases.
+ */
interface TableBinding extends Binding {
/**
* Gets the number of columns in the TableBinding, as an integer value.
*
* @remarks
- * | Hosts | Access, Excel,Word |
- *
- * | Requirement Sets | TableBindings |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
columnCount: number;
/**
* True, if the table has headers; otherwise false.
*
* @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | TableBindings |
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
hasHeaders: boolean;
/**
* Gets the number of rows in the TableBinding, as an integer value.
*
* @remarks
- * | Hosts | Access, Excel,Word |
- *
- * | Requirement Sets | TableBindings |
- *
* When you insert an empty table by selecting a single row in Excel 2013 and Excel Online (using Table on the Insert tab), both Office host applications create a single row of headers followed by a single blank row. However, if your add-in's script creates a binding for this newly inserted table (for example, by using the addFromSelectionAsync method), and then checks the value of the rowCount property, the value returned will differ depending whether the spreadsheet is open in Excel 2013 or Excel Online.
-
* - In Excel on the desktop, rowCount will return 0 (the blank row following the headers is not counted).
*
* - In Excel Online, rowCount will return 1 (the blank row following the headers is counted).
@@ -3377,15 +4257,26 @@ declare namespace Office {
* You can work around this difference in your script by checking if rowCount == 1, and if so, then checking if the row contains all empty strings.
*
* In content add-ins for Access, for performance reasons the rowCount property always returns -1.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*/
rowCount: number;
/**
* Adds the specified data to the table as additional columns.
*
* @remarks
- * | Hosts | Excel, Word |
- *
- * | Requirement Sets | TableBindings |
*
* To add one or more columns specifying the values of the data and headers, pass a TableData object as the data parameter. To add one or more columns specifying only the data, pass an array of arrays ("matrix") as the data parameter.
*
@@ -3398,6 +4289,19 @@ declare namespace Office {
* - If you pass a TableData object as the data argument, the number of header rows must match that of the table being updated.
*
* Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in a single call to this method.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3408,9 +4312,6 @@ declare namespace Office {
* Adds the specified data to the table as additional rows.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
- * | Requirement Sets | TableBindings |
*
* To add one or more columns specifying the values of the data and headers, pass a TableData object as the data parameter. To add one or more columns specifying only the data, pass an array of arrays ("matrix") as the data parameter.
*
@@ -3423,6 +4324,20 @@ declare namespace Office {
* - If you pass a TableData object as the data argument, the number of header rows must match that of the table being updated.
*
* Additional remark for Excel Online: The total number of cells in the TableData object passed to the data parameter can't exceed 20,000 in a single call to this method.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3433,11 +4348,22 @@ declare namespace Office {
* Deletes all non-header rows and their values in the table, shifting appropriately for the host application.
*
* @remarks
- * | Hosts | Access, Excel, Word |
- *
- * | Requirement Sets | TableBindings |
*
* In Excel, if the table has no header row, this method will delete the table itself.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Access | | Y | |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -3447,11 +4373,19 @@ declare namespace Office {
* Clears formatting on the bound table.
*
* @remarks
- * | Hosts | Excel |
- *
- * | Requirement Sets | Not in a set |
- *
* See {@link https://docs.microsoft.com/en-us/office/dev/add-ins/excel/excel-add-ins-tables#format-a-table | Format tables in add-ins for Excel} for more information.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ *
*
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
@@ -3469,9 +4403,6 @@ declare namespace Office {
* Sets formatting on specified items and data in the table.
*
* @remarks
- * | Hosts | Excel |
- *
- * | Requirement Sets | Not in a set |
*
* **Specifying the cellFormat parameter**
*
@@ -3580,6 +4511,18 @@ declare namespace Office {
* A user-defined item of any type that is returned in the AsyncResult object without being altered. |
*
*
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ *
*
* @param cellFormat An array that contains one or more JavaScript objects that specify which cells to target and the formatting to apply to them.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3618,6 +4561,18 @@ declare namespace Office {
* A user-defined item of any type that is returned in the AsyncResult object without being altered. |
*
*
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ *
*
* @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply.
* @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -3705,15 +4660,26 @@ declare namespace Office {
Headers
}
/**
- * Represents a bound text selection in the document.
- *
- * @remarks
- * | Hosts | Access, Excel, PowerPoint, Project, Word |
- *
- * | Requirement Sets | TextBindings |
- *
- * The TextBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the {@link Office.Binding} object. It does not implement any additional properties or methods of its own.
- */
+ * Represents a bound text selection in the document.
+ *
+ * @remarks
+ * | Requirement Sets | TextBindings |
+ *
+ * The TextBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the {@link Office.Binding} object. It does not implement any additional properties or methods of its own.
+ *
+ * **Support details**
+ *
+ * A capital Y in the following matrix indicates that this interface is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this interface.
+ *
+ * For more information about Office host application and server requirements, see {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
+ *
+ * *Supported hosts, by platform*
+ *
+ * | | Office for Windows desktop | Office Online (in browser) | Office for iPad |
|---|
+ * | Excel | Y | Y | Y |
|---|
+ * | Word | Y | Y | Y |
|---|
+ *
+ */
interface TextBinding extends Binding { }
/**
* Specifies the project fields that are available as a parameter for the {@link Office.Document | Document}.getProjectFieldAsync method.
diff --git a/types/owl.carousel/index.d.ts b/types/owl.carousel/index.d.ts
index b1b093ef77..9b4fbe5e89 100644
--- a/types/owl.carousel/index.d.ts
+++ b/types/owl.carousel/index.d.ts
@@ -61,6 +61,7 @@ declare namespace OwlCarousel {
dotsContainer?: string | boolean;
checkVisible?: boolean;
slideTransition?: string;
+ autoHeight?: boolean;
// CLASSES
refreshClass?: string;
loadingClass?: string;
diff --git a/types/pouchdb-core/index.d.ts b/types/pouchdb-core/index.d.ts
index ddecfe843b..0dbf5def5b 100644
--- a/types/pouchdb-core/index.d.ts
+++ b/types/pouchdb-core/index.d.ts
@@ -626,7 +626,7 @@ declare namespace PouchDB {
};
}
- interface Database {
+ interface Database extends EventEmitter {
/** The name passed to the PouchDB constructor and unique identifier of the database. */
name: string;
diff --git a/types/pouchdb-core/pouchdb-core-tests.ts b/types/pouchdb-core/pouchdb-core-tests.ts
index fe79997461..f8accd1c3a 100644
--- a/types/pouchdb-core/pouchdb-core-tests.ts
+++ b/types/pouchdb-core/pouchdb-core-tests.ts
@@ -114,6 +114,8 @@ function testBasics() {
const db = new PouchDB();
+ db.on("closed", () => {});
+
db.post(model).then((result) => {
isString(result.id);
});
diff --git a/types/pretty-ms/index.d.ts b/types/pretty-ms/index.d.ts
index e23b26826b..b1e151cd65 100644
--- a/types/pretty-ms/index.d.ts
+++ b/types/pretty-ms/index.d.ts
@@ -1,6 +1,7 @@
-// Type definitions for pretty-ms 3.0
+// Type definitions for pretty-ms 3.2
// Project: https://github.com/sindresorhus/pretty-ms#readme
// Definitions by: BendingBender
+// ocboogie
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
export = prettyMs;
@@ -11,6 +12,7 @@ declare namespace prettyMs {
interface PrettyMsOptions {
secDecimalDigits?: number;
msDecimalDigits?: number;
+ keepDecimalsOnWholeSeconds?: boolean;
compact?: boolean;
verbose?: boolean;
}
diff --git a/types/pretty-ms/pretty-ms-tests.ts b/types/pretty-ms/pretty-ms-tests.ts
index 14bff61304..ae5e8120b2 100644
--- a/types/pretty-ms/pretty-ms-tests.ts
+++ b/types/pretty-ms/pretty-ms-tests.ts
@@ -4,6 +4,7 @@ let str: string;
str = prettyMs(133);
str = prettyMs(1337, {compact: true});
str = prettyMs(1335669000, {verbose: true});
+str = prettyMs(1335669000, {keepDecimalsOnWholeSeconds: true});
str = prettyMs(1335669000, {secDecimalDigits: 1});
str = prettyMs(1335669000, {msDecimalDigits: 2});
str = prettyMs(new Date(2014, 0, 1, 10, 40).getTime() - new Date(2014, 0, 1, 10, 5).getTime());
diff --git a/types/quill/index.d.ts b/types/quill/index.d.ts
index afbdfa9222..0eda9a4eff 100644
--- a/types/quill/index.d.ts
+++ b/types/quill/index.d.ts
@@ -4,6 +4,7 @@
// Guillaume
// James Garbutt
// Aniello Falcone
+// Mohammad Hossein Amri
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import { Blot } from 'parchment/dist/src/blot/abstract/blot';
@@ -42,6 +43,7 @@ export interface KeyboardStatic {
}
export interface ClipboardStatic {
+ convert(html?: string): DeltaStatic;
addMatcher(selectorOrNodeType: string|number, callback: (node: any, delta: DeltaStatic) => DeltaStatic): void;
dangerouslyPasteHTML(html: string, source?: Sources): void;
dangerouslyPasteHTML(index: number, html: string, source?: Sources): void;
diff --git a/types/quill/quill-tests.ts b/types/quill/quill-tests.ts
index d0bc3a2189..073e68f115 100644
--- a/types/quill/quill-tests.ts
+++ b/types/quill/quill-tests.ts
@@ -129,7 +129,7 @@ function test_updateContents() {
}));
}
-function test_setContents() {
+function test_setDeltaContents() {
const quillEditor = new Quill('#editor');
quillEditor.setContents(new Delta({ ops: [
{ insert: 'Hello ' },
@@ -138,11 +138,19 @@ function test_setContents() {
]}));
}
-function test_setText() {
+function test_setTextContents() {
const quillEditor = new Quill('#editor');
quillEditor.setText('Hello\n');
}
+function test_setHtmlContents() {
+ const quillEditor = new Quill('#editor');
+ const html = "this is a bold text";
+ const delta = quillEditor.clipboard.convert(html);
+ quillEditor.setContents(delta);
+ quillEditor.clipboard.convert();
+}
+
function test_getSelection() {
const quillEditor = new Quill('#editor');
const range = quillEditor.getSelection();
diff --git a/types/react-adal/index.d.ts b/types/react-adal/index.d.ts
index 9f3cd9bef2..40a8d5d3bc 100644
--- a/types/react-adal/index.d.ts
+++ b/types/react-adal/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/salvoravida/react-adal#readme
// Definitions by: Dmitry Korolev
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-addons-create-fragment/index.d.ts b/types/react-addons-create-fragment/index.d.ts
index 1e46046ec4..25e4ba9b43 100644
--- a/types/react-addons-create-fragment/index.d.ts
+++ b/types/react-addons-create-fragment/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-addons-css-transition-group/index.d.ts b/types/react-addons-css-transition-group/index.d.ts
index 33d43b4cd1..03cdc48303 100644
--- a/types/react-addons-css-transition-group/index.d.ts
+++ b/types/react-addons-css-transition-group/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import 'react-addons-transition-group';
import { ComponentClass, CSSTransitionGroupProps } from 'react';
diff --git a/types/react-addons-linked-state-mixin/index.d.ts b/types/react-addons-linked-state-mixin/index.d.ts
index 6358dde535..1c590e333f 100644
--- a/types/react-addons-linked-state-mixin/index.d.ts
+++ b/types/react-addons-linked-state-mixin/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Mixin } from 'react';
diff --git a/types/react-addons-pure-render-mixin/index.d.ts b/types/react-addons-pure-render-mixin/index.d.ts
index 565a108721..a154dbe594 100644
--- a/types/react-addons-pure-render-mixin/index.d.ts
+++ b/types/react-addons-pure-render-mixin/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Mixin } from 'react';
diff --git a/types/react-addons-shallow-compare/index.d.ts b/types/react-addons-shallow-compare/index.d.ts
index ff4e5dbdc9..5d6942ed24 100644
--- a/types/react-addons-shallow-compare/index.d.ts
+++ b/types/react-addons-shallow-compare/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component } from 'react';
diff --git a/types/react-addons-test-utils/index.d.ts b/types/react-addons-test-utils/index.d.ts
index 9282f95f4e..0531c5e3f6 100644
--- a/types/react-addons-test-utils/index.d.ts
+++ b/types/react-addons-test-utils/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { AbstractView, Component, ComponentClass,
ReactElement, ReactInstance, ClassType,
diff --git a/types/react-addons-transition-group/index.d.ts b/types/react-addons-transition-group/index.d.ts
index 933533df28..79f76bf84e 100644
--- a/types/react-addons-transition-group/index.d.ts
+++ b/types/react-addons-transition-group/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { ComponentClass, TransitionGroupProps } from 'react';
diff --git a/types/react-addons-update/index.d.ts b/types/react-addons-update/index.d.ts
index 874549b7a1..5a1018d2c2 100644
--- a/types/react-addons-update/index.d.ts
+++ b/types/react-addons-update/index.d.ts
@@ -2,7 +2,7 @@
// Project: http://facebook.github.io/react/
// Definitions by: Asana , AssureSign , Microsoft
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-aria-modal/index.d.ts b/types/react-aria-modal/index.d.ts
index 83ca6d3a34..4083d08473 100644
--- a/types/react-aria-modal/index.d.ts
+++ b/types/react-aria-modal/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/davidtheclark/react-aria-modal#readme
// Definitions by: forabi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import React = require('react');
diff --git a/types/react-dom-factories/index.d.ts b/types/react-dom-factories/index.d.ts
index eaf04f766f..b0bcb5bfa6 100644
--- a/types/react-dom-factories/index.d.ts
+++ b/types/react-dom-factories/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://facebook.github.io/react/
// Definitions by: John Gozde
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
export as namespace ReactDOMFactories;
export = ReactDOMFactories;
diff --git a/types/react-dom/index.d.ts b/types/react-dom/index.d.ts
index e7a5afe59d..518c0c617c 100644
--- a/types/react-dom/index.d.ts
+++ b/types/react-dom/index.d.ts
@@ -6,7 +6,7 @@
// MartynasZilinskas
// Josh Rutherford
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
export as namespace ReactDOM;
diff --git a/types/react-dom/v15/index.d.ts b/types/react-dom/v15/index.d.ts
index bd39e0a5e1..8a22fd9bc2 100644
--- a/types/react-dom/v15/index.d.ts
+++ b/types/react-dom/v15/index.d.ts
@@ -5,7 +5,7 @@
// Microsoft
// MartynasZilinskas
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
export as namespace ReactDOM;
diff --git a/types/react-dragtastic/index.d.ts b/types/react-dragtastic/index.d.ts
index 64ce099e2f..fbfaf42cff 100644
--- a/types/react-dragtastic/index.d.ts
+++ b/types/react-dragtastic/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/chrisjpatty/react-dragtastic#readme
// Definitions by: Nicolás Scarcella
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { ReactNode, Component, MouseEventHandler, TouchEventHandler } from 'react';
diff --git a/types/react-flag-icon-css/index.d.ts b/types/react-flag-icon-css/index.d.ts
index ad1777670a..74c3e04efe 100644
--- a/types/react-flag-icon-css/index.d.ts
+++ b/types/react-flag-icon-css/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/matteocng/react-flag-icon-css#readme
// Definitions by: Jon Freedman
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as CSS from 'csstype';
import { PureComponent, ReactNode } from 'react';
diff --git a/types/react-highlight/index.d.ts b/types/react-highlight/index.d.ts
index 2ab09ee3a9..715a25b23b 100644
--- a/types/react-highlight/index.d.ts
+++ b/types/react-highlight/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/akiran/react-highlight
// Definitions by: Josh Goldberg
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
diff --git a/types/react-i18next/index.d.ts b/types/react-i18next/index.d.ts
index e7b9c88526..979c648f50 100644
--- a/types/react-i18next/index.d.ts
+++ b/types/react-i18next/index.d.ts
@@ -3,6 +3,7 @@
// Definitions by: Giedrius Grabauskas
// Simon Baumann
// Benedict Etzel
+// Wu Haotian
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
diff --git a/types/react-i18next/src/I18n.d.ts b/types/react-i18next/src/I18n.d.ts
index 6bc1cf8f0f..91de868caf 100644
--- a/types/react-i18next/src/I18n.d.ts
+++ b/types/react-i18next/src/I18n.d.ts
@@ -15,7 +15,7 @@ export interface i18nProps {
i18n?: i18n;
initialI18nStore?: any;
initialLanguage?: string;
- children: (t: TranslationFunction, options: Options) => JSX.Element;
+ children: (t: TranslationFunction, options: Options) => React.ReactNode;
}
export default class I18n extends React.Component { }
diff --git a/types/react-i18next/src/I18nextProvider.d.ts b/types/react-i18next/src/I18nextProvider.d.ts
index 2cd4e333e3..2db5d0361b 100644
--- a/types/react-i18next/src/I18nextProvider.d.ts
+++ b/types/react-i18next/src/I18nextProvider.d.ts
@@ -6,7 +6,7 @@ export interface I18nextProviderProps {
i18n: i18n;
initialI18nStore?: any;
initialLanguage?: string;
- children: JSX.Element;
+ children: React.ReactNode;
}
export default class I18nextProvider extends React.Component { }
diff --git a/types/react-i18next/test/react-i18next-tests.tsx b/types/react-i18next/test/react-i18next-tests.tsx
index d3afe7643a..30b95ece24 100644
--- a/types/react-i18next/test/react-i18next-tests.tsx
+++ b/types/react-i18next/test/react-i18next-tests.tsx
@@ -107,6 +107,10 @@ class App extends React.Component {
;
+
+ 123
+;
+
loadNamespaces({components: [App], i18n}).then(() => {
}).catch(error => {
});
@@ -182,6 +186,10 @@ interface CustomTranslateFunctionProps {
}
;
+
+ {t => '123'}
+;
+
const defaults: ReactI18NextOptions = {
wait: true,
withRef: true,
diff --git a/types/react-input-autosize/index.d.ts b/types/react-input-autosize/index.d.ts
index f8f6f5b06f..0a86381736 100644
--- a/types/react-input-autosize/index.d.ts
+++ b/types/react-input-autosize/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/JedWatson/react-input-autosize#readme
// Definitions by: Jason Unger
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.7
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-intl/react-intl-tests.tsx b/types/react-intl/react-intl-tests.tsx
index 2ed6eb0d98..782c4de889 100644
--- a/types/react-intl/react-intl-tests.tsx
+++ b/types/react-intl/react-intl-tests.tsx
@@ -4,6 +4,7 @@
*/
import * as React from "react";
+import * as PropTypes from "prop-types";
import * as reactMixin from "react-mixin";
import {
@@ -63,8 +64,9 @@ const SomeFunctionalComponentWithIntl: React.ComponentClass
});
class SomeComponent extends React.Component {
- static propTypes: React.ValidationMap = {
- intl: intlShape.isRequired
+ static propTypes: React.ValidationMap = {
+ intl: intlShape.isRequired,
+ className: PropTypes.string.isRequired
};
render(): React.ReactElement<{}> {
const intl = this.props.intl;
diff --git a/types/react-mailchimp-subscribe/index.d.ts b/types/react-mailchimp-subscribe/index.d.ts
index 558c6a92cd..55b5c487ed 100644
--- a/types/react-mailchimp-subscribe/index.d.ts
+++ b/types/react-mailchimp-subscribe/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://revolunet.github.io/react-mailchimp-subscribe/
// Definitions by: Omar Diab
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component, ReactNode } from "react";
diff --git a/types/react-map-gl/index.d.ts b/types/react-map-gl/index.d.ts
index 6209e66e81..2260644d32 100644
--- a/types/react-map-gl/index.d.ts
+++ b/types/react-map-gl/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: Robert Imig
// Fabio Berta
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import * as MapboxGL from 'mapbox-gl';
diff --git a/types/react-maskedinput/index.d.ts b/types/react-maskedinput/index.d.ts
index 3a1b4687eb..dc38064cab 100644
--- a/types/react-maskedinput/index.d.ts
+++ b/types/react-maskedinput/index.d.ts
@@ -4,7 +4,7 @@
// Adam Lavin
// Carlos Bonetti
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
diff --git a/types/react-mce/index.d.ts b/types/react-mce/index.d.ts
index 6f1fb978db..1db5f00286 100644
--- a/types/react-mce/index.d.ts
+++ b/types/react-mce/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/janstuemmel/react-mce
// Definitions by: Gavin Heise
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import * as ActualTinyMCE from 'tinymce';
diff --git a/types/react-mdl/index.d.ts b/types/react-mdl/index.d.ts
index caf910d421..1b83bf7def 100644
--- a/types/react-mdl/index.d.ts
+++ b/types/react-mdl/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/tleunen/react-mdl
// Definitions by: Brad Zacher
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-measure/index.d.ts b/types/react-measure/index.d.ts
index 241d482a53..9cd5853948 100644
--- a/types/react-measure/index.d.ts
+++ b/types/react-measure/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/souporserious/react-measure
// Definitions by: Alexey Svetliakov , Marc Fallows
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
diff --git a/types/react-mixin/index.d.ts b/types/react-mixin/index.d.ts
index 265794afe2..284d278ff8 100644
--- a/types/react-mixin/index.d.ts
+++ b/types/react-mixin/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/brigand/react-mixin
// Definitions by: Qubo
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
///
diff --git a/types/react-modal/index.d.ts b/types/react-modal/index.d.ts
index 9dfbf7bdf7..237c725332 100644
--- a/types/react-modal/index.d.ts
+++ b/types/react-modal/index.d.ts
@@ -7,7 +7,7 @@
// Uwe Wiemer ,
// Peter Blazejewicz
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
diff --git a/types/react-motion-slider/index.d.ts b/types/react-motion-slider/index.d.ts
index 2e7ea921ef..a53ec42259 100644
--- a/types/react-motion-slider/index.d.ts
+++ b/types/react-motion-slider/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/souporserious/react-motion-slider
// Definitions by: Alexey Svetliakov
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
declare module "react-motion-slider" {
import * as React from "react";
diff --git a/types/react-motion-ui-pack/index.d.ts b/types/react-motion-ui-pack/index.d.ts
index 0e0e518f70..477cf0e604 100644
--- a/types/react-motion-ui-pack/index.d.ts
+++ b/types/react-motion-ui-pack/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/souporserious/react-motion-ui-pack
// Definitions by: Jason Unger
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import * as motion from 'react-motion';
diff --git a/types/react-motion/index.d.ts b/types/react-motion/index.d.ts
index f4f94095a8..761c8e559f 100644
--- a/types/react-motion/index.d.ts
+++ b/types/react-motion/index.d.ts
@@ -4,7 +4,7 @@
// Alexey Svetliakov
// Dimitar Nestorov
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component, ReactElement } from 'react';
diff --git a/types/react-native-android-taskdescription/index.d.ts b/types/react-native-android-taskdescription/index.d.ts
index 0f395e91f2..172f47fe00 100644
--- a/types/react-native-android-taskdescription/index.d.ts
+++ b/types/react-native-android-taskdescription/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/jwarby/react-native-android-taskdescription
// Definitions by: Christian Chown
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-native-autocomplete-input/index.d.ts b/types/react-native-autocomplete-input/index.d.ts
index f6c5f06eb6..9e39a47241 100644
--- a/types/react-native-autocomplete-input/index.d.ts
+++ b/types/react-native-autocomplete-input/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/l-urence/react-native-autocomplete-input#readme
// Definitions by: Ifiok Jr.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component, ReactNode } from 'react';
import {
diff --git a/types/react-native-bluetooth-serial/index.d.ts b/types/react-native-bluetooth-serial/index.d.ts
index 8dc4d9c1a1..7dc49dcf83 100644
--- a/types/react-native-bluetooth-serial/index.d.ts
+++ b/types/react-native-bluetooth-serial/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/rusel1989/react-native-bluetooth-serial
// Definitions by: Rodrigo Weber
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
import * as ReactNative from "react-native";
diff --git a/types/react-native-calendars/index.d.ts b/types/react-native-calendars/index.d.ts
index 6294af4682..3784c1f628 100644
--- a/types/react-native-calendars/index.d.ts
+++ b/types/react-native-calendars/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/wix/react-native-calendars#readme
// Definitions by: Tyler Zhang
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewProps, StyleProp } from 'react-native';
diff --git a/types/react-native-datepicker/index.d.ts b/types/react-native-datepicker/index.d.ts
index dfc8bd5b13..929acdc375 100644
--- a/types/react-native-datepicker/index.d.ts
+++ b/types/react-native-datepicker/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/xgfe/react-native-datepicker
// Definitions by: Jacob Baskin
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ImageURISource } from 'react-native';
diff --git a/types/react-native-dialog/index.d.ts b/types/react-native-dialog/index.d.ts
index 3a1cf94be9..10e977f420 100644
--- a/types/react-native-dialog/index.d.ts
+++ b/types/react-native-dialog/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/mmazzarolo/react-native-dialog
// Definitions by: MrLuje
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Ref, PureComponent, ReactNode } from "react";
import {
diff --git a/types/react-native-dialogflow/index.d.ts b/types/react-native-dialogflow/index.d.ts
index c1b663ddb5..59ebff7cdf 100644
--- a/types/react-native-dialogflow/index.d.ts
+++ b/types/react-native-dialogflow/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/innFactory/react-native-dialogflow#readme
// Definitions by: Jason Merino
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
export namespace Dialogflow {
const LANG_CHINESE_CHINA = 'zh-CN';
diff --git a/types/react-native-doc-viewer/index.d.ts b/types/react-native-doc-viewer/index.d.ts
index 6d09e3966a..f7e28147b7 100644
--- a/types/react-native-doc-viewer/index.d.ts
+++ b/types/react-native-doc-viewer/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/philipphecht/react-native-doc-viewer/blob/master/README.md
// Definitions by: Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
export function openDoc(
files: Array<{ url: string; fileName?: string }>,
diff --git a/types/react-native-drawer-layout/index.d.ts b/types/react-native-drawer-layout/index.d.ts
index af3a05698e..3bf4ace1db 100644
--- a/types/react-native-drawer-layout/index.d.ts
+++ b/types/react-native-drawer-layout/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/react-native-community/react-native-drawer-layout
// Definitions by: Justin Firth
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewProps } from 'react-native';
diff --git a/types/react-native-drawer/index.d.ts b/types/react-native-drawer/index.d.ts
index 3a82e3363a..da3420b9a7 100644
--- a/types/react-native-drawer/index.d.ts
+++ b/types/react-native-drawer/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: jnbt
// suniahk
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewStyle, ScaledSize } from 'react-native';
diff --git a/types/react-native-elevated-view/index.d.ts b/types/react-native-elevated-view/index.d.ts
index e9ac2b1103..7c538a4742 100644
--- a/types/react-native-elevated-view/index.d.ts
+++ b/types/react-native-elevated-view/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/alekhurst/react-native-elevated-view
// Definitions by: fhelwanger
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import * as ReactNative from 'react-native';
diff --git a/types/react-native-fbsdk/index.d.ts b/types/react-native-fbsdk/index.d.ts
index 8b948d6b0d..eacc05209e 100644
--- a/types/react-native-fbsdk/index.d.ts
+++ b/types/react-native-fbsdk/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/facebook/react-native-fbsdk
// Definitions by: Ifiok Jr.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { ComponentClass, Component } from 'react';
import { ViewStyle } from 'react-native';
diff --git a/types/react-native-fs/index.d.ts b/types/react-native-fs/index.d.ts
index 17f26a5514..6c92933c44 100644
--- a/types/react-native-fs/index.d.ts
+++ b/types/react-native-fs/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: Paulo Cesar
// Joseph Roque
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
///
diff --git a/types/react-native-google-signin/index.d.ts b/types/react-native-google-signin/index.d.ts
index 862a40a35a..6cf83ed1e4 100644
--- a/types/react-native-google-signin/index.d.ts
+++ b/types/react-native-google-signin/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/devfd/react-native-google-signin
// Definitions by: Jacob Froman
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewProps } from 'react-native';
diff --git a/types/react-native-htmlview/index.d.ts b/types/react-native-htmlview/index.d.ts
index b0eb2ae6a3..0f2b9d661d 100644
--- a/types/react-native-htmlview/index.d.ts
+++ b/types/react-native-htmlview/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/jsdf/react-native-htmlview
// Definitions by: Ifiok Jr.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component, ComponentType, ReactNode } from 'react';
import {
diff --git a/types/react-native-indicators/index.d.ts b/types/react-native-indicators/index.d.ts
index ee4a13a4c2..1a732d8cee 100644
--- a/types/react-native-indicators/index.d.ts
+++ b/types/react-native-indicators/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/n4kz/react-native-indicators#readme
// Definitions by: Ifiok Jr.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component } from 'react';
import { Animated, EasingFunction } from 'react-native';
diff --git a/types/react-native-keep-awake/index.d.ts b/types/react-native-keep-awake/index.d.ts
index f22d1342c6..c717e83ba3 100644
--- a/types/react-native-keep-awake/index.d.ts
+++ b/types/react-native-keep-awake/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/corbt/react-native-keep-awake
// Definitions by: huhuanming
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
declare class KeepAwake extends React.Component<{ children?: JSX.Element }> {
diff --git a/types/react-native-keyboard-spacer/index.d.ts b/types/react-native-keyboard-spacer/index.d.ts
index 0c7ec24262..49ad68de41 100644
--- a/types/react-native-keyboard-spacer/index.d.ts
+++ b/types/react-native-keyboard-spacer/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/Andr3wHur5t/react-native-keyboard-spacer#readme
// Definitions by: Vincent Langlet
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import * as ReactNative from 'react-native';
diff --git a/types/react-native-loading-spinner-overlay/index.d.ts b/types/react-native-loading-spinner-overlay/index.d.ts
index 93d511d863..aa494b5fd4 100644
--- a/types/react-native-loading-spinner-overlay/index.d.ts
+++ b/types/react-native-loading-spinner-overlay/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/joinspontaneous/react-native-loading-spinner-overlay
// Definitions by: fhelwanger
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
import * as ReactNative from "react-native";
diff --git a/types/react-native-material-design-searchbar/index.d.ts b/types/react-native-material-design-searchbar/index.d.ts
index 23b3204c76..ed9534a38c 100644
--- a/types/react-native-material-design-searchbar/index.d.ts
+++ b/types/react-native-material-design-searchbar/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/ananddayalan/react-native-material-design-searchbar
// Definitions by: Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native-material-kit/index.d.ts b/types/react-native-material-kit/index.d.ts
index f820d8e4cd..48c044a629 100644
--- a/types/react-native-material-kit/index.d.ts
+++ b/types/react-native-material-kit/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: Kyle Roach
// Tim Wang
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native-material-textfield/index.d.ts b/types/react-native-material-textfield/index.d.ts
index 5f3ffc437f..c21caa15b4 100644
--- a/types/react-native-material-textfield/index.d.ts
+++ b/types/react-native-material-textfield/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: Ville Venäläinen
// Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native-material-ui/index.d.ts b/types/react-native-material-ui/index.d.ts
index 3c4c549504..8bb86d3cc3 100644
--- a/types/react-native-material-ui/index.d.ts
+++ b/types/react-native-material-ui/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/xotahal/react-native-material-ui
// Definitions by: Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component } from 'react';
import { ViewStyle, TextStyle, Image } from 'react-native';
diff --git a/types/react-native-modalbox/index.d.ts b/types/react-native-modalbox/index.d.ts
index 84461471f2..778f953f78 100644
--- a/types/react-native-modalbox/index.d.ts
+++ b/types/react-native-modalbox/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/maxs15/react-native-modalbox#readme
// Definitions by: Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { StyleProp, ViewStyle } from 'react-native';
diff --git a/types/react-native-multi-slider/index.d.ts b/types/react-native-multi-slider/index.d.ts
index a3a5f39c63..42d4856938 100644
--- a/types/react-native-multi-slider/index.d.ts
+++ b/types/react-native-multi-slider/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/JackDanielsAndCode/react-native-multi-slider#readme
// Definitions by: Edward Sammut Alessi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
import { ViewStyle } from "react-native";
diff --git a/types/react-native-navbar/index.d.ts b/types/react-native-navbar/index.d.ts
index 5c21ea38e8..afcd7df3ed 100644
--- a/types/react-native-navbar/index.d.ts
+++ b/types/react-native-navbar/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/react-native-community/react-native-navbar
// Definitions by: Ryo Kikuchi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewStyle, TextProps } from 'react-native';
diff --git a/types/react-native-photo-view/index.d.ts b/types/react-native-photo-view/index.d.ts
index c3f27d78a6..c104b1c0e5 100644
--- a/types/react-native-photo-view/index.d.ts
+++ b/types/react-native-photo-view/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/alwx/react-native-photo-view
// Definitions by: Christian Chown
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ImageSourcePropType, ViewProps } from 'react-native';
diff --git a/types/react-native-popup-dialog/index.d.ts b/types/react-native-popup-dialog/index.d.ts
index 5ddb40e0b2..3ff12802f4 100644
--- a/types/react-native-popup-dialog/index.d.ts
+++ b/types/react-native-popup-dialog/index.d.ts
@@ -4,7 +4,7 @@
// connectdotz
// Michele Bombardi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { GestureResponderEvent, StyleProp, ViewStyle, TextStyle } from 'react-native';
diff --git a/types/react-native-qrcode/index.d.ts b/types/react-native-qrcode/index.d.ts
index 7c745aa1b6..97709c5792 100644
--- a/types/react-native-qrcode/index.d.ts
+++ b/types/react-native-qrcode/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/cssivision/react-native-qrcode
// Definitions by: York Yao
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-native-safari-view/index.d.ts b/types/react-native-safari-view/index.d.ts
index 658a6664ce..77b8aa15e8 100644
--- a/types/react-native-safari-view/index.d.ts
+++ b/types/react-native-safari-view/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/naoufal/react-native-safari-view
// Definitions by: Michael Randolph
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { EmitterSubscription } from 'react-native';
diff --git a/types/react-native-scrollable-tab-view/index.d.ts b/types/react-native-scrollable-tab-view/index.d.ts
index 962ba8a810..9be23aa66c 100644
--- a/types/react-native-scrollable-tab-view/index.d.ts
+++ b/types/react-native-scrollable-tab-view/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: CaiHuan
// Egor Shulga
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { Animated, ScrollViewProps, ViewStyle, TextStyle } from 'react-native';
diff --git a/types/react-native-sensor-manager/index.d.ts b/types/react-native-sensor-manager/index.d.ts
index 0b0f0bf67a..9c25be10ba 100644
--- a/types/react-native-sensor-manager/index.d.ts
+++ b/types/react-native-sensor-manager/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/kprimice/react-native-sensor-manager
// Definitions by: Sahin Vardar
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
///
diff --git a/types/react-native-settings-list/index.d.ts b/types/react-native-settings-list/index.d.ts
index 0ba14c9562..e04b856296 100644
--- a/types/react-native-settings-list/index.d.ts
+++ b/types/react-native-settings-list/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/evetstech/react-native-settings-list
// Definitions by: MrLuje
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component, ReactNode } from "react";
import { TextStyle, StyleProp, ImageStyle, ViewStyle } from "react-native";
diff --git a/types/react-native-snap-carousel/index.d.ts b/types/react-native-snap-carousel/index.d.ts
index 56b083638b..3c630bc094 100644
--- a/types/react-native-snap-carousel/index.d.ts
+++ b/types/react-native-snap-carousel/index.d.ts
@@ -4,7 +4,7 @@
// Jacob Froman
// Nikolay Polukhin
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native-sortable-grid/index.d.ts b/types/react-native-sortable-grid/index.d.ts
index 392e9b1b01..0551d56efe 100644
--- a/types/react-native-sortable-grid/index.d.ts
+++ b/types/react-native-sortable-grid/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/ollija/react-native-sortable-grid#readme
// Definitions by: Jacob Froman
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { StyleProp, ViewStyle, Animated } from 'react-native';
diff --git a/types/react-native-sortable-list/index.d.ts b/types/react-native-sortable-list/index.d.ts
index d5466c8f68..65b34ce62f 100755
--- a/types/react-native-sortable-list/index.d.ts
+++ b/types/react-native-sortable-list/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/gitim/react-native-sortable-list
// Definitions by: Michael Sivolobov , Vince Maiuri
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewStyle } from 'react-native';
diff --git a/types/react-native-star-rating/index.d.ts b/types/react-native-star-rating/index.d.ts
index 2285134c8f..a26002bf88 100644
--- a/types/react-native-star-rating/index.d.ts
+++ b/types/react-native-star-rating/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/djchie/react-native-star-rating
// Definitions by: iRoachie
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ImageURISource, StyleProp, ViewStyle } from 'react-native';
diff --git a/types/react-native-svg-uri/index.d.ts b/types/react-native-svg-uri/index.d.ts
index 4529c53d5e..a47550bced 100644
--- a/types/react-native-svg-uri/index.d.ts
+++ b/types/react-native-svg-uri/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/matiascba/react-native-svg-uri#readme
// Definitions by: Kyle Roach
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ImageURISource } from 'react-native';
diff --git a/types/react-native-swiper/index.d.ts b/types/react-native-swiper/index.d.ts
index c6616aea0c..a201bcd00b 100644
--- a/types/react-native-swiper/index.d.ts
+++ b/types/react-native-swiper/index.d.ts
@@ -4,7 +4,7 @@
// HuHuanming
// mhcgrq
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native-tab-navigator/index.d.ts b/types/react-native-tab-navigator/index.d.ts
index 1f4e5e5437..1586b7279a 100644
--- a/types/react-native-tab-navigator/index.d.ts
+++ b/types/react-native-tab-navigator/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/exponentjs/react-native-tab-navigator#readme
// Definitions by: My Self
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { ViewStyle, TextStyle } from 'react-native';
diff --git a/types/react-native-tab-view/index.d.ts b/types/react-native-tab-view/index.d.ts
index 0e5ee892ce..078247e97d 100644
--- a/types/react-native-tab-view/index.d.ts
+++ b/types/react-native-tab-view/index.d.ts
@@ -4,7 +4,7 @@
// Kyle Roach
// Tim Wang
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { PureComponent, ReactNode, ComponentType } from 'react'
import {
Animated,
diff --git a/types/react-native-text-input-mask/index.d.ts b/types/react-native-text-input-mask/index.d.ts
index 33505ccc54..4cf4b392dc 100644
--- a/types/react-native-text-input-mask/index.d.ts
+++ b/types/react-native-text-input-mask/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/react-native-community/react-native-text-input-mask
// Definitions by: Rodrigo Weber
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
import * as ReactNative from "react-native";
diff --git a/types/react-native-toast-native/index.d.ts b/types/react-native-toast-native/index.d.ts
index 130614290b..6240441781 100644
--- a/types/react-native-toast-native/index.d.ts
+++ b/types/react-native-toast-native/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/onemolegames/react-native-toast-native/blob/master/README.md
// Definitions by: Michele Bombardi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Platform } from 'react-native';
diff --git a/types/react-native-vector-icons/index.d.ts b/types/react-native-vector-icons/index.d.ts
index 60e6408d18..6aabaadd70 100644
--- a/types/react-native-vector-icons/index.d.ts
+++ b/types/react-native-vector-icons/index.d.ts
@@ -3,7 +3,7 @@
// Definitions by: Kyle Roach
// Tim Wang
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import { Icon } from './Icon';
diff --git a/types/react-native-video/index.d.ts b/types/react-native-video/index.d.ts
index d4ba6900f8..e84bcc7637 100644
--- a/types/react-native-video/index.d.ts
+++ b/types/react-native-video/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/react-native-community/react-native-video
// Definitions by: HuHuanming
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
import {
diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts
index abec02a1b3..aff434f277 100644
--- a/types/react-native/index.d.ts
+++ b/types/react-native/index.d.ts
@@ -12,7 +12,7 @@
// Tanguy Krotoff
// Alexander T.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
diff --git a/types/react-navigation/index.d.ts b/types/react-navigation/index.d.ts
index e5e9ea00d8..2573315c09 100644
--- a/types/react-navigation/index.d.ts
+++ b/types/react-navigation/index.d.ts
@@ -20,7 +20,7 @@
// Luca Campana
// Ullrich Schaefer
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
/**
* Reference: https://github.com/react-navigation/react-navigation/tree/a37473c5e4833f48796ee6c7c9cb4a8ac49d9c06
diff --git a/types/react-navigation/v1/index.d.ts b/types/react-navigation/v1/index.d.ts
index 1233ca39e3..16779c4e4e 100644
--- a/types/react-navigation/v1/index.d.ts
+++ b/types/react-navigation/v1/index.d.ts
@@ -17,7 +17,7 @@
// Ciaran Liedeman
// Edward Sammut Alessi
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
/**
* Reference: https://github.com/react-navigation/react-navigation/tree/3f3ef6485c8932f49fddc3dd2c508629110bf2b6
diff --git a/types/react-no-ssr/index.d.ts b/types/react-no-ssr/index.d.ts
index 77d52af1ff..9ca00149d0 100644
--- a/types/react-no-ssr/index.d.ts
+++ b/types/react-no-ssr/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/kadirahq/react-no-ssr
// Definitions by: Rafał Filipek
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from 'react';
diff --git a/types/react-notification-system-redux/index.d.ts b/types/react-notification-system-redux/index.d.ts
index d74ea35871..701bde55cf 100644
--- a/types/react-notification-system-redux/index.d.ts
+++ b/types/react-notification-system-redux/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/gor181/react-notification-system-redux
// Definitions by: Karol Janyst
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import { Component } from "react";
import { Action } from "redux";
diff --git a/types/react-notification-system/index.d.ts b/types/react-notification-system/index.d.ts
index a993f6cc4d..d172cd6b2c 100644
--- a/types/react-notification-system/index.d.ts
+++ b/types/react-notification-system/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://www.npmjs.com/package/react-notification-system
// Definitions by: Giedrius Grabauskas , Deividas Bakanas , Karol Janyst , Bartosz Szewczyk
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.6
+// TypeScript Version: 2.8
import * as React from "react";
diff --git a/types/react-notify-toast/index.d.ts b/types/react-notify-toast/index.d.ts
index 689d543ce8..1feb26ef61 100644
--- a/types/react-notify-toast/index.d.ts
+++ b/types/react-notify-toast/index.d.ts
@@ -2,7 +2,7 @@
// Project: https://github.com/jesusoterogomez/react-notify-toast
// Definitions by: Klaas Cuvelier