Skip to content

Commit

Permalink
Bug 1869678 - Fixup and improve JSDocs for better type inference r=robwu
Browse files Browse the repository at this point in the history
Differential Revision: https://phabricator.services.mozilla.com/D196385

UltraBlame original commit: 1c6e48c2b096e91d8c9304bffabd3c22f07ea5a8
  • Loading branch information
marco-c committed Jan 1, 2024
1 parent f6b47fe commit e29e1d8
Show file tree
Hide file tree
Showing 30 changed files with 884 additions and 99 deletions.
150 changes: 148 additions & 2 deletions toolkit/components/extensions/ConduitsParent.sys.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,9 @@ property
{
ConduitID
}
[
id
]
Globally
unique
across
Expand Down Expand Up @@ -238,6 +240,104 @@ string
cast
]
*
*
property
{
*
}
[
actor
]
*
property
{
boolean
}
[
verified
]
*
property
{
string
}
[
url
]
*
property
{
number
}
[
frameId
]
*
property
{
string
}
[
workerScriptURL
]
*
property
{
string
}
[
extensionId
]
*
property
{
string
}
[
envType
]
*
property
{
string
}
[
instanceId
]
*
property
{
number
}
[
portId
]
*
property
{
boolean
}
[
native
]
*
property
{
boolean
}
[
source
]
*
property
{
string
}
[
reportOnClosed
]
*
*
Lists
of
recvX
Expand Down Expand Up @@ -2026,8 +2126,16 @@ arg
returns
{
Promise
<
any
[
]
>
|
Promise
<
Response
>
}
*
/
Expand Down Expand Up @@ -2373,11 +2481,27 @@ errors
.
*
*
typedef
{
{
response
?
:
any
received
?
:
boolean
}
}
Response
*
*
param
{
Promise
<
response
Response
>
[
]
Expand All @@ -2388,7 +2512,7 @@ returns
{
Promise
<
response
Response
?
>
}
Expand Down Expand Up @@ -2686,6 +2810,17 @@ name
*
param
{
import
(
"
ConduitsChild
.
sys
.
mjs
"
)
.
MessageData
}
data
Expand Down Expand Up @@ -2919,6 +3054,17 @@ name
*
param
{
import
(
"
ConduitsChild
.
sys
.
mjs
"
)
.
MessageData
}
options
Expand Down
47 changes: 45 additions & 2 deletions toolkit/components/extensions/Extension.sys.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6219,6 +6219,8 @@ function
type
id
)
:
boolean
}
options
.
Expand Down Expand Up @@ -6272,7 +6274,10 @@ temporary
*
returns
{
Promise
<
ExtensionData
>
}
*
/
Expand Down Expand Up @@ -6912,9 +6917,12 @@ directory
*
returns
{
Promise
<
string
[
]
>
}
*
An
Expand Down Expand Up @@ -9236,7 +9244,10 @@ necessary
*
returns
{
Promise
<
object
>
}
normalized
manifest
Expand Down Expand Up @@ -13313,6 +13324,25 @@ getAPIManager
(
)
{
/
*
*
type
{
(
InstanceType
<
typeof
ExtensionCommon
.
LazyAPIManager
>
)
[
]
}
*
/
let
apiManagers
=
Expand Down Expand Up @@ -15444,9 +15474,11 @@ param
{
boolean
}
[
options
.
collapseOrigins
]
*
Wether
to
Expand All @@ -15468,9 +15500,11 @@ param
{
boolean
}
[
options
.
buildOptionalOrigins
]
*
Wether
to
Expand Down Expand Up @@ -21748,10 +21782,10 @@ necessary
param
{
string
|
undefined
}
[
reason
]
*
If
provided
Expand Down Expand Up @@ -22233,6 +22267,15 @@ startup
was
interrupted
.
/
*
*
type
{
callback
}
*
/
let
resolveReadyPromise
;
Expand Down
7 changes: 4 additions & 3 deletions toolkit/components/extensions/ExtensionActions.sys.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,8 @@ string
}
prop
*
String
Name
of
property
to
retrieve
Expand All @@ -901,10 +902,10 @@ of
"
icon
"
*
"
title
"
*
"
badgeText
"
Expand All @@ -922,7 +923,7 @@ enabled
*
returns
{
string
any
}
value
*
Expand Down
4 changes: 3 additions & 1 deletion toolkit/components/extensions/ExtensionActivityLog.sys.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -331,9 +331,11 @@ data
*
param
{
string
Date
}
[
timeStamp
]
The
timestamp
for
Expand Down
Loading

0 comments on commit e29e1d8

Please sign in to comment.