Data type normalization (long-term effort)

[pklaschka]

Currently, the UXP JS API references don't follow a standard when it comes to declaring data types. A few examples of various ways things are notated in the docs (and, "as the root", the corresponding JS type):

• number
  • int
  • integer
  • number
  • Number
  • Integer
• string
  • string
  • String
• Promise<void>
  • (no type specified at all, "in lieu of" void)
  • Promise
  • void

While this will be a big effort to fix, it currently

• can cause a lot of confusion ("Is there a difference between these?")
• disallows for any automated processing (e.g., to generate TypeScript definitions from it)
• makes the documentation seem much less consistent (and thus, subjectively, harder to work with)

[padmkris123]

Adding my observations here for inconsistent data types:

• Boolean, bool, boolean
• Array array
• ** any
• *Object object

Other:

• Nested angular brackets such as Promise<Array> should be changed to Promise<string[]>.

[pklaschka]

Additional context:

• https://stackoverflow.com/a/64443353
• https://www.typescriptlang.org/docs/handbook/2/everyday-types.html

[pklaschka]

Internal note: This now has a page on the internal wiki with best practices.