@types/office-js 1.0.456 → 1.0.458

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, 21 Jan 2025 19:02:30 GMT
11
+ * Last updated: Wed, 29 Jan 2025 22:02:46 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -19910,9 +19910,10 @@ declare namespace Office {
19910
19910
  * your add-in has persisted changes.
19911
19911
  * The persisted changes will not be available until the task pane (or item in the case of UI-less add-ins) is closed and reopened.
19912
19912
  *
19913
- * - When set and saved through Outlook on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} or classic) or on Mac,
19914
- * these settings are reflected in Outlook on the web only after a browser refresh.
19915
- *
19913
+ * - In classic Outlook on Windows, if roaming settings were configured on another Outlook client, the desktop client doesn't need to be restarted.
19914
+ * However, the add-in needs to be reloaded to access these settings. In Outlook on the web, on Mac, and in the new Outlook on Windows,
19915
+ * you must refresh the browser or restart the client to access roaming settings set on another client.
19916
+ *
19916
19917
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
19917
19918
  *
19918
19919
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -119547,47 +119548,47 @@ declare namespace PowerPoint {
119547
119548
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119548
119549
  context: RequestContext;
119549
119550
  /**
119550
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
119551
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
119551
119552
  *
119552
119553
  * @remarks
119553
119554
  * [Api set: PowerPointApi 1.4]
119554
119555
  */
119555
- bold: boolean;
119556
+ bold: boolean | null;
119556
119557
  /**
119557
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
119558
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
119558
119559
  *
119559
119560
  * @remarks
119560
119561
  * [Api set: PowerPointApi 1.4]
119561
119562
  */
119562
- color: string;
119563
+ color: string | null;
119563
119564
  /**
119564
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
119565
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
119565
119566
  *
119566
119567
  * @remarks
119567
119568
  * [Api set: PowerPointApi 1.4]
119568
119569
  */
119569
- italic: boolean;
119570
+ italic: boolean | null;
119570
119571
  /**
119571
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
119572
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
119572
119573
  *
119573
119574
  * @remarks
119574
119575
  * [Api set: PowerPointApi 1.4]
119575
119576
  */
119576
- name: string;
119577
+ name: string | null;
119577
119578
  /**
119578
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
119579
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
119579
119580
  *
119580
119581
  * @remarks
119581
119582
  * [Api set: PowerPointApi 1.4]
119582
119583
  */
119583
- size: number;
119584
+ size: number | null;
119584
119585
  /**
119585
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
119586
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
119586
119587
  *
119587
119588
  * @remarks
119588
119589
  * [Api set: PowerPointApi 1.4]
119589
119590
  */
119590
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
119591
+ underline: ShapeFontUnderlineStyle | null;
119591
119592
  /**
119592
119593
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119593
119594
  *
@@ -121588,47 +121589,47 @@ declare namespace PowerPoint {
121588
121589
  /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121589
121590
  interface ShapeFontUpdateData {
121590
121591
  /**
121591
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121592
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
121592
121593
  *
121593
121594
  * @remarks
121594
121595
  * [Api set: PowerPointApi 1.4]
121595
121596
  */
121596
- bold?: boolean;
121597
+ bold?: boolean | null;
121597
121598
  /**
121598
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121599
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
121599
121600
  *
121600
121601
  * @remarks
121601
121602
  * [Api set: PowerPointApi 1.4]
121602
121603
  */
121603
- color?: string;
121604
+ color?: string | null;
121604
121605
  /**
121605
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121606
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
121606
121607
  *
121607
121608
  * @remarks
121608
121609
  * [Api set: PowerPointApi 1.4]
121609
121610
  */
121610
- italic?: boolean;
121611
+ italic?: boolean | null;
121611
121612
  /**
121612
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
121613
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
121613
121614
  *
121614
121615
  * @remarks
121615
121616
  * [Api set: PowerPointApi 1.4]
121616
121617
  */
121617
- name?: string;
121618
+ name?: string | null;
121618
121619
  /**
121619
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121620
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
121620
121621
  *
121621
121622
  * @remarks
121622
121623
  * [Api set: PowerPointApi 1.4]
121623
121624
  */
121624
- size?: number;
121625
+ size?: number | null;
121625
121626
  /**
121626
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
121627
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
121627
121628
  *
121628
121629
  * @remarks
121629
121630
  * [Api set: PowerPointApi 1.4]
121630
121631
  */
121631
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121632
+ underline?: ShapeFontUnderlineStyle | null;
121632
121633
  }
121633
121634
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
121634
121635
  interface ShapeCollectionUpdateData {
@@ -122014,47 +122015,47 @@ declare namespace PowerPoint {
122014
122015
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122015
122016
  interface ShapeFontData {
122016
122017
  /**
122017
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122018
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
122018
122019
  *
122019
122020
  * @remarks
122020
122021
  * [Api set: PowerPointApi 1.4]
122021
122022
  */
122022
- bold?: boolean;
122023
+ bold?: boolean | null;
122023
122024
  /**
122024
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122025
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
122025
122026
  *
122026
122027
  * @remarks
122027
122028
  * [Api set: PowerPointApi 1.4]
122028
122029
  */
122029
- color?: string;
122030
+ color?: string | null;
122030
122031
  /**
122031
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122032
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
122032
122033
  *
122033
122034
  * @remarks
122034
122035
  * [Api set: PowerPointApi 1.4]
122035
122036
  */
122036
- italic?: boolean;
122037
+ italic?: boolean | null;
122037
122038
  /**
122038
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
122039
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
122039
122040
  *
122040
122041
  * @remarks
122041
122042
  * [Api set: PowerPointApi 1.4]
122042
122043
  */
122043
- name?: string;
122044
+ name?: string | null;
122044
122045
  /**
122045
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122046
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
122046
122047
  *
122047
122048
  * @remarks
122048
122049
  * [Api set: PowerPointApi 1.4]
122049
122050
  */
122050
- size?: number;
122051
+ size?: number | null;
122051
122052
  /**
122052
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122053
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122053
122054
  *
122054
122055
  * @remarks
122055
122056
  * [Api set: PowerPointApi 1.4]
122056
122057
  */
122057
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122058
+ underline?: ShapeFontUnderlineStyle | null;
122058
122059
  }
122059
122060
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
122060
122061
  interface ShapeCollectionData {
@@ -122658,42 +122659,42 @@ declare namespace PowerPoint {
122658
122659
  */
122659
122660
  $all?: boolean;
122660
122661
  /**
122661
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122662
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
122662
122663
  *
122663
122664
  * @remarks
122664
122665
  * [Api set: PowerPointApi 1.4]
122665
122666
  */
122666
122667
  bold?: boolean;
122667
122668
  /**
122668
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122669
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
122669
122670
  *
122670
122671
  * @remarks
122671
122672
  * [Api set: PowerPointApi 1.4]
122672
122673
  */
122673
122674
  color?: boolean;
122674
122675
  /**
122675
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122676
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
122676
122677
  *
122677
122678
  * @remarks
122678
122679
  * [Api set: PowerPointApi 1.4]
122679
122680
  */
122680
122681
  italic?: boolean;
122681
122682
  /**
122682
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
122683
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
122683
122684
  *
122684
122685
  * @remarks
122685
122686
  * [Api set: PowerPointApi 1.4]
122686
122687
  */
122687
122688
  name?: boolean;
122688
122689
  /**
122689
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122690
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
122690
122691
  *
122691
122692
  * @remarks
122692
122693
  * [Api set: PowerPointApi 1.4]
122693
122694
  */
122694
122695
  size?: boolean;
122695
122696
  /**
122696
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122697
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122697
122698
  *
122698
122699
  * @remarks
122699
122700
  * [Api set: PowerPointApi 1.4]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.456",
3
+ "version": "1.0.458",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "0256f2db3a0b32621585d0f7a4874d5ec9a92a9d244661abf2187a8b0b297274",
49
+ "typesPublisherContentHash": "1697b78197c2707c737b0d11c99cbbec421b5ab0eb3811f8895bb37efd7ba1bb",
50
50
  "typeScriptVersion": "5.0"
51
51
  }