mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix routingId type

Browse source 
Previous phrasing confused electron-typescript-definitions,
thinking that routingId was of type `unique` 😃
This commit is contained in:
Charles Kerr 2018-05-11 13:05:05 -05:00
parent 8acbfca06b
commit 13877ce2c8
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/api/web-frame.md
View file

@ -237,10 +237,10 @@ renderer process.
### `webFrame.findFrameByRoutingId(routingId)` ### `webFrame.findFrameByRoutingId(routingId)`
* `routingId` Integer - A unique frame id in the current renderer process. * `routingId` Integer - An `Integer` representing the unique frame id in the
Routing IDs can be retrieved from `WebFrame` instances (`webFrame.routingId`) current renderer process. Routing IDs can be retrieved from `WebFrame`
and are also passed by frame specific `WebContents` navigation events (e.g. instances (`webFrame.routingId`) and are also passed by frame
`did-frame-navigate`) specific `WebContents` navigation events (e.g. `did-frame-navigate`)
Returns `WebFrame` - that has the supplied `routingId`, `null` if not found. Returns `WebFrame` - that has the supplied `routingId`, `null` if not found.
@ -276,5 +276,6 @@ current renderer process.
### `webFrame.routingId` ### `webFrame.routingId`
A unique frame id in the current renderer process. Distinct WebFrame instances An `Integer` representing the unique frame id in the current renderer process.
that refer to the same underlying frame will have the same `routingId`. Distinct WebFrame instances that refer to the same underlying frame will have
the same `routingId`.