81795744cf
* fix: ensure the typescript definitions only export correct value types In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes #22167 * chore: update typescript-defs * chore: update typescript-defs * chore: fix bad typescript in IPC test * docs: test rendering of new syntax * chore: update per feedback, use same syntax but with 'this is not exportedd' line
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
## Class: BrowserWindowProxy
|
|
|
|
> Manipulate the child browser window
|
|
|
|
Process: [Renderer](../glossary.md#renderer-process)<br />
|
|
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
|
|
|
|
The `BrowserWindowProxy` object is returned from `window.open` and provides
|
|
limited functionality with the child window.
|
|
|
|
### Instance Methods
|
|
|
|
The `BrowserWindowProxy` object has the following instance methods:
|
|
|
|
#### `win.blur()`
|
|
|
|
Removes focus from the child window.
|
|
|
|
#### `win.close()`
|
|
|
|
Forcefully closes the child window without calling its unload event.
|
|
|
|
#### `win.eval(code)`
|
|
|
|
* `code` String
|
|
|
|
Evaluates the code in the child window.
|
|
|
|
#### `win.focus()`
|
|
|
|
Focuses the child window (brings the window to front).
|
|
|
|
#### `win.print()`
|
|
|
|
Invokes the print dialog on the child window.
|
|
|
|
#### `win.postMessage(message, targetOrigin)`
|
|
|
|
* `message` any
|
|
* `targetOrigin` String
|
|
|
|
Sends a message to the child window with the specified origin or `*` for no
|
|
origin preference.
|
|
|
|
In addition to these methods, the child window implements `window.opener` object
|
|
with no properties and a single method.
|
|
|
|
### Instance Properties
|
|
|
|
The `BrowserWindowProxy` object has the following instance properties:
|
|
|
|
#### `win.closed`
|
|
|
|
A `Boolean` that is set to true after the child window gets closed.
|