app
Retrieve Eagle application attributes like version, architecture, and language.
Here are common attributes for the app
:
Methods
isDarkColors()
Check if the current system is in dark (Dark) mode.
Returns
boolean
- Whether the current system is in Dark mode.
getPath(name)
You can request the following paths by name:
name
string - You can request the following paths by name:home
- User's home folder (main directory)appData
- Application data directory for each user, defaults to:userData
- Folder for storing your application configuration files, default is the appData folder plus the application's name. User data files should be written here by convention, but it is not recommended to write large files, as some environments will back up this directory to cloud storage.temp
- Temporary folderexe
- Current executable filedesktop
- Current user's desktop folderdocuments
- Path of the user's documents directorydownloads
- Path of the user's download directorymusic
- Path of the user's music directorypictures
- Path of the user's picture directoryvideos
- Path of the user's video directoryrecent
- Directory of the user's recent files (Windows only).
Returns
Promise<path: string>
-path
query path result.
getFileIcon(path[, options])
Get the icon associated with the specified path file.
path
string - File path for which you want to get the iconoptions
Object (optional)size
stringsmall
- 16x16normal
- 32x32large
- 32x32 onWindows
, not supported onmacOS
.
Returns
Promise<img: NativeImage>
createThumbnailFromPath(path, maxSize)
Get the icon associated with the file at the specified path.
path
string - The file path to get the thumbnail frommaxSize
Size - The maximum width and height (positive number) of the returned thumbnail. On Windows platform, maxSize.height will be ignored and height will be scaled according to maxSize.widthReturns
Promise<img: NativeImage>
Properties
version
string
property, get the current Eagle application version.
build
number
property, get the current Eagle application Build Number.
locale
string
property, get the current Eagle application interface language.
en
- Englishzh_CN
- Simplified Chinesezh_TW
- Traditional Chineseja_JP
- Japaneseko_KR
- Koreanes_ES
- Spanishde_DE
- Germanru_RU
- Russian
arch
string
property, returns the CPU architecture of the operating system.
x64
arm64
x86
platform
string
property, returns a string identifying the operating system platform.
darwin
- macOS operating systemwin32
- Windows operating system
env
Object
property, returns an object of environment variables.
execPath
string
property, current application execution path.
pid
number
property, current plugin process id.
isWindows
boolean
property, is the current operating system Windows.
isMac
boolean
property, is the current operating system Mac.
runningUnderARM64Translation
theme
string
property, the current theme color name, such as LIGHT
, LIGHTGRAY
, GRAY
, DARK
, BLUE
, PURPLE
.
Last updated