UXP API reference for v6.4 #90

padmkris123 · 2022-12-13T20:39:53Z

UXP API reference for v6.4

Description

This PR contains changes to UXP API reference docs for v6.4.0

Related Issue

Motivation and Context

This change is required to keep the various product documentation site up to date with latest UXP API reference.

How Has This Been Tested?

Tested locally

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

pklaschka

Partial review (1/n)

See inline comments. I'm not sure if it's wise to, for primitive types, use capitalized type names (string, number, etc.), since this can cause confusion in the TypeScript world:

https://www.typescriptlang.org/docs/handbook/2/everyday-types.html

Cases where this came up are marked with a reference to the corresponding issue (#86)

pklaschka · 2022-12-13T21:43:40Z

src/pages/uxp/reference-js/Global Members/HTML DOM/Element.md

+| Param | Type |
+| --- | --- |
+| value | `string` | 
+
+
+


This doesn't feel right. It might be coming from a set function, but this just makes the "multiple innerHTML confusion" worse 🤔

pklaschka · 2022-12-13T21:44:44Z

src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLWebViewElement.md

@@ -6,13  6,13 @@

 | Name | Type | Description |
 | --- | --- | --- |
-| uxpallowinspector | `boolean` | Enable Developer tools for WebView e.g., `<webview src="https://www.adobe.com" uxpallowinspector="true"></webview>` |
+| uxpallowinspector | `Boolean` | Enable Developer tools for WebView <br></br> e.g., `<webview src="https://www.adobe.com" uxpallowinspector="true"></webview>` |


pklaschka · 2022-12-13T21:44:53Z

src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLWebViewElement.md




 <a name="htmlwebviewelement-src" id="htmlwebviewelement-src"></a>

-## src : `string`
+## src : `String`


pklaschka · 2022-12-13T21:55:18Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+<a name="path-sep" id="path-sep"></a>
+
+## sep


Missing type

@padmkris123 .... we will update the changes in v7.0.
For now please pick the updates from nodejs public docs https://nodejs.org/api/path.html#pathsep

pklaschka · 2022-12-13T21:55:23Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+<a name="path-delimiter" id="path-delimiter"></a>
+
+## delimiter


Missing type

@padmkris123 .... we will update the changes in v7.0.
For now please pick the updates from nodejs public docs https://nodejs.org/api/path.html#pathdelimiter

pklaschka · 2022-12-13T22:18:49Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md


-**Returns**: `string` - the session token for the given entry  
+**Returns**: `String` - the session token for the given entry  


pklaschka · 2022-12-13T22:18:53Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md

@@ -220,21  215,16 @@ Returns the file system Entry that corresponds to the session token obtained fro

 | Param | Type |
 | --- | --- |
-| token | `string` | 
+| token | `String` | 


pklaschka · 2022-12-13T22:19:00Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md


-**Returns**: `Promise<string>` - the persistent token for the given entry  
+**Returns**: `Promise<String>` - the persistent token for the given entry  


pklaschka · 2022-12-13T22:19:09Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md


 **Returns**: `Promise<Entry>` - the corresponding entry for the persistent token  

 | Param | Type |
 | --- | --- |
-| token | `string` | 
+| token | `String` | 


pklaschka · 2022-12-13T22:19:12Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/FileSystemProvider.md

@@ -296,7  280,7 @@ if (!success) {
 Checks if the supplied object is a `FileSystemProvider`. It's safe to use even
 if the object is `null` or `undefined`. Useful for type checking.

-**Returns**: `boolean` - If `true`, the object is a file system provider  
+**Returns**: `Boolean` - If `true`, the object is a file system provider  


pklaschka

Partial review (2/2)

A small change request regarding a description.

I haven't marked the type notation inconsistenciy issues in the remaining files since we're now discussing this separately and it would only add clutter to this review.

pklaschka · 2022-12-14T20:26:07Z

src/pages/uxp/reference-js/Modules/uxp/Persistent File Storage/errors.md

+<a name="module-storage-errors-notsupported" id="module-storage-errors-notsupported"></a>
+
+## NotSupported
+Not supported error


This doesn't feel like a great description if I'm a developer looking for details on this error. This might have small impact if the actual error.message is clear, but this is not visible from this review.

@padmkris123 ... you can remove this part for now. It looks like this was removed even in docs-6.3.
I will check with the dev if an appropriate description can be provided for upcoming releases

kareemmyk · 2022-12-15T02:05:00Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+Normalize a string path, reducing '..' and '.' parts.
+When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
+
+**Returns**: `String` - normalized string path  


@padmkris123 ... please update the String with string.
For 6.5 why have modified it to string

kareemmyk · 2022-12-15T02:05:18Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+| Param | Type | Description |
+| --- | --- | --- |
+| path | `String` \| `Entry` | path to normalize |


Same as above

kareemmyk · 2022-12-15T02:05:37Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+## join(paths)
+Join all arguments together and normalize the resulting path.
+
+**Returns**: `String` - joined string path  


Same as above

kareemmyk · 2022-12-15T02:14:04Z

src/pages/uxp/reference-js/Modules/FileSystem.md

@@ -101,16  101,16 @@ const strLen = await fs.writeFile("plugin-data:/textFile.txt", "It was a dark an
 Writes data to a path synchronously, appending if desired.
 The format of the file is controlled via the encoding option, and defaults to a binary format.

+**Returns**: `int` - the length of contents written to the file  


@padmkris123 ... this should be Promise<number> .
This is fixed in docs-6.5

kareemmyk · 2022-12-15T02:15:09Z

src/pages/uxp/reference-js/Modules/FileSystem.md

+**Returns**: `int` - 0 if succeeded, otherwise throws an Error  
+


kareemmyk · 2022-12-15T04:15:02Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+<a name="path-delimiter" id="path-delimiter"></a>
+
+## delimiter


@padmkris123 .... we will update the changes in v7.0.
For now please pick the updates from nodejs public docs https://nodejs.org/api/path.html#pathdelimiter

kareemmyk · 2022-12-15T04:15:41Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+<a name="path-posix" id="path-posix"></a>
+
+## posix


@padmkris123 .... we will update the changes in v7.0.
For now please pick the updates from nodejs public docs https://nodejs.org/api/path.html#pathposix

kareemmyk · 2022-12-15T04:16:05Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+<a name="path-win32" id="path-win32"></a>
+
+## win32


@padmkris123 .... we will update the changes in v7.0.
For now please pick the updates from nodejs public docs https://nodejs.org/api/path.html#pathwin32

kareemmyk · 2022-12-15T04:35:15Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+
+| Param | Type | Description |
+| --- | --- | --- |
+| pathObject | `object` | path to evaluate |


@padmkris123 ... please refer https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules__types_node_path_d_._path_.path.platformpath.html#extname

format(pP: [FormatInputPathObject](https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules__types_node_path_d_._path_.path.formatinputpathobject.html)): string Defined in node_modules/@types/node/path.d.ts:136 Returns a path string from an object - the opposite of parse(). Parameters pP: [FormatInputPathObject](https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules__types_node_path_d_._path_.path.formatinputpathobject.html) Returns string```

kareemmyk · 2022-12-15T04:35:52Z

src/pages/uxp/reference-js/Global Members/Path/Path.md

+## parse(path)
+Returns an object from a path string - the opposite of format().
+
+**Returns**: `object` - ParsedPath  


@padmkris123 ... please refer https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules__types_node_path_d_._path_.path.platformpath.html#parse

padmkris123 · 2022-12-15T22:08:21Z

Will open a fresh PR after addressing the review comments.

Padma Krishnamoorthy added 5 commits December 13, 2022 12:21

new doc fixes

1136d6c

updating versions md

874196c

New API: window.Path

370ac04

Fixing product name

99e8cf8

Bumping package version number

1a55b21

padmkris123 requested a review from pklaschka December 13, 2022 20:40

Padma Krishnamoorthy added 2 commits December 13, 2022 13:04

removing TODO

85bb4dd

removing extra uxp

b987202

pklaschka suggested changes Dec 13, 2022

View reviewed changes

pklaschka suggested changes Dec 14, 2022

View reviewed changes

kareemmyk requested changes Dec 15, 2022

View reviewed changes

Padma Krishnamoorthy added 4 commits December 15, 2022 14:06

Manually fixing issue #86

2c564aa

Typos

bb30fbc

Reverting changes

78162a2

Addressing issue #86 and adding Object details

bcd9726

padmkris123 closed this Dec 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UXP API reference for v6.4 #90

UXP API reference for v6.4 #90

padmkris123 commented Dec 13, 2022

pklaschka left a comment

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

kareemmyk Dec 15, 2022

pklaschka Dec 13, 2022

kareemmyk Dec 15, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka Dec 13, 2022

pklaschka left a comment

pklaschka Dec 14, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

kareemmyk Dec 15, 2022

padmkris123 commented Dec 15, 2022


		<a name="path-delimiter" id="path-delimiter"></a>

		## delimiter


		Returns: `string` - the session token for the given entry
		Returns: `String` - the session token for the given entry


		Returns: `Promise<string>` - the persistent token for the given entry
		Returns: `Promise<String>` - the persistent token for the given entry

		Returns: `int` - 0 if succeeded, otherwise throws an Error

UXP API reference for v6.4 #90

UXP API reference for v6.4 #90

Conversation

padmkris123 commented Dec 13, 2022

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

pklaschka left a comment

Choose a reason for hiding this comment

Partial review (1/n)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pklaschka left a comment

Choose a reason for hiding this comment

Partial review (2/2)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

padmkris123 commented Dec 15, 2022