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

Add Pear.media.getPathForFile(file) documentation (#164)

Browse Source
This commit is contained in:
Sean Zellmer
2025-01-17 05:42:27 -06:00
committed by GitHub
parent f2f9cfeaa0
commit e2d6acccf0
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
reference/pear/api.md
View File

@@ -338,6 +338,16 @@ Captures available desktop sources. Resolves to an array of objects with shape `
* https://www.electronjs.org/docs/latest/api/structures/desktop-capturer-source
* [`<NativeImage>`](https://www.electronjs.org/docs/latest/api/native-image)
### `const path = Pear.media.getPathForFile(file <File>)`
Accepts a web [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File/File) object and returns the file system path for that file as a `String`. In cases where the `file` argument is not a `File` object an exception is thrown. In the case that the `file` is constructed in JS and is not backed by a file on disk an empty string is returned.
Available in Desktop Applications only.
**References**
* https://www.electronjs.org/docs/latest/api/web-utils#webutilsgetpathforfilefile
### `Pear.versions <Async Function>`
Function that returns a promise which resolves to a Pear versions object with the shape `{ fork <Integer>, length <Integer>, key <Buffer> }`.