aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 06:24:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Pear release 1.7.0 (#158)

Browse Source 
* Remove `.getMediaSourceId()` documentation

Removed in: https://github.com/holepunchto/pear/pull/420

* Note that `Pear.restart()` & `Pear.reload()` is Desktop Only

* Revert "reverted dump dry-run flag"

This reverts commit 5eaee12d96.
This commit is contained in:
Sean Zellmer
2024-12-05 14:42:19 -06:00
committed by GitHub
parent 5eaee12d96
commit c6b63ae9fa
2 changed files with 4 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
reference/pear/api.md
View File

@@ -334,10 +334,6 @@ Captures available desktop sources. Resolves to an array of objects with shape `
**References**
* [win.getMediaSourceId()](#const-sourceid--await-wingetmediasourceid)
* [view.getMediaSourceId()](#const-sourceid--await-viewgetmediasourceid)
* [self.getMediaSourceId()](#const-sourceid--await-selfgetmediasourceid)
* [parent.getMediaSourceId()](#const-sourceid--await-parentgetmediasourceid)
* https://www.electronjs.org/docs/latest/api/desktop-capturer#desktopcapturergetsourcesoptions
* https://www.electronjs.org/docs/latest/api/structures/desktop-capturer-source
* [`<NativeImage>`](https://www.electronjs.org/docs/latest/api/native-image)
@@ -379,11 +375,12 @@ will be waited upon until resolution before calling the next teardown handler.
### Pear.reload()
Soft-restart Terminal applications (keeps I/O), refresh application in Desktop applications.
Refresh application in Desktop applications. Not available in terminal
applications.
### `Pear.restart()`
Restart the application.
Restart the application. Desktop Applications only.
### `Pear.exit(code)`
@@ -566,17 +563,6 @@ Unmaximize/unminimize the window if it is currently maximized/minimized.
Send arguments to the window. They will be serialized with `JSON.stringify`.
### `const sourceId = await win.getMediaSourceId()`
Resolves to: `<String>`
Correlates to the `id` property of objects in the array returned from [Pear.media.desktopSources](#const-sources---await-appmediadesktopsources-options).
**References**
* [Pear.media.desktopSources](#const-sources--await-appmediadesktopsourcesoptions-object)
* https://www.electronjs.org/docs/latest/api/browser-window#wingetmediasourceid
### `const dimensions = await win.dimensions()`
Resolves to: `{x <Integer>, y <Integer>, width <Integer>, height <Integer>} | null`.
@@ -732,17 +718,6 @@ Blur the view.
Send arguments to the view. They will be serialized with `JSON.stringify`.
### `const sourceId = await view.getMediaSourceId()`
Resolves to: `<String>`
Supplies the `id` property of objects in the array returned from [Pear.media.desktopSources](#const-sources---await-appmediadesktopsources-options).
**References**
* [Pear.media.desktopSources](#const-sources---await-appmediadesktopsources-options)
* https://www.electronjs.org/docs/latest/api/browser-window#wingetmediasourceid
### `const dimensions = await view.dimensions()`
Resolves to: `{x <Integer>, y <Integer>, width <Integer>, height <Integer>} | null`.
@@ -830,15 +805,6 @@ Resolves to: `<Boolean>`
Hide current view or window.
### `const sourceId = await self.getMediaSourceId()`
Get the sourceId of the current window or view.
**References**
* [win.getMediaSourceId()](const-sourceId--await-wingetMediaSourceId)
### `const success = await self.minimize()`
Resolves to: `<Boolean>`
@@ -925,15 +891,6 @@ Resolves to: `<Boolean>`
Hide parent view or window.
### `const sourceId = await parent.getMediaSourceId()`
Get the sourceId of the parent window or view.
**References**
* [win.getMediaSourceId()](#const-sourceId--await-wingetMediaSourceId)
### `const success = await parent.minimize()`
Resolves to: `<Boolean>`