@types/office-js 1.0.328 → 1.0.329

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 06 Jun 2023 23:02:52 GMT
11
+ * Last updated: Fri, 09 Jun 2023 17:33:06 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -19342,8 +19342,15 @@ declare namespace OfficeExtension {
19342
19342
  readonly debugInfo: RequestContextDebugInfo;
19343
19343
  }
19344
19344
 
19345
+ /**
19346
+ * Specifies options for a session of a Visio diagram embedded in a SharePoint page. Called by constructor of `EmbeddedSession`.
19347
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
19348
+ */
19345
19349
  interface EmbeddedOptions {
19346
19350
  sessionKey?: string,
19351
+ /*
19352
+ * The iframe element that hosts the Visio diagram.
19353
+ */
19347
19354
  container?: HTMLElement,
19348
19355
  id?: string;
19349
19356
  timeoutInMilliseconds?: number;
@@ -19351,8 +19358,15 @@ declare namespace OfficeExtension {
19351
19358
  width?: string;
19352
19359
  }
19353
19360
 
19361
+ /**
19362
+ * Represents a session of a Visio diagram embedded in a SharePoint page.
19363
+ * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/reference/overview/visio-javascript-reference-overview | Visio JavaScript API overview}.
19364
+ */
19354
19365
  class EmbeddedSession {
19355
19366
  constructor(url: string, options?: EmbeddedOptions);
19367
+ /**
19368
+ * Initializes the session.
19369
+ */
19356
19370
  public init(): Promise<any>;
19357
19371
  }
19358
19372
 
@@ -19518,13 +19532,25 @@ declare namespace OfficeExtension {
19518
19532
  remove(handler: (args: T) => Promise<any>): void;
19519
19533
  }
19520
19534
 
19535
+ /**
19536
+ * Enables the removal of an event handler. Returned by the `EventHandlers.add` method.
19537
+ *
19538
+ * **Note**: The same {@link OfficeExtension.ClientRequestContext | RequestContext} object that the handler was added in must be used when removing the handler.
19539
+ * More information can be found in {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-events#remove-an-event-handler | Remove an event handler}.
19540
+ */
19521
19541
  class EventHandlerResult<T> {
19522
19542
  constructor(context: ClientRequestContext, handlers: EventHandlers<T>, handler: (args: T) => Promise<any>);
19523
19543
  /** The request context associated with the object */
19524
19544
  context: ClientRequestContext;
19545
+ /*
19546
+ * Removes the handler from the event.
19547
+ */
19525
19548
  remove(): void;
19526
19549
  }
19527
19550
 
19551
+ /**
19552
+ * Used by Office to construct event handlers. Do not call in your code.
19553
+ */
19528
19554
  interface EventInfo<T> {
19529
19555
  registerFunc: (callback: (args: any) => void) => Promise<any>;
19530
19556
  unregisterFunc: (callback: (args: any) => void) => Promise<any>;
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.328",
3
+ "version": "1.0.329",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "241809be6e9b550afa2f9adbbac21123be3e724db8de4d44b354a261eddc0655",
48
+ "typesPublisherContentHash": "c999fce12f63f793997cc192638b8d3ea904ce3e6b097605a62ff067972626ef",
49
49
  "typeScriptVersion": "4.3"
50
50
  }