wallpaper
Get or set the desktop wallpaper
Works on macOS 10.12+, Linux, and Windows 10+ Windows 7+.
Install
$ npm install wallpaper
Usage
const wallpaper = ; async { await wallpaper; await wallpaper; //=> '/Users/sindresorhus/unicorn.jpg'};
API
.get([options])
Returns a promise for the path of the current desktop wallpaper.
options
Type: Object
screen (macOS only)
Type: string
number
Values: all
main
or the index of a screen from .screens()
Default: main
The screen to get the wallpaper from.
.set(imagePath, [options])
Returns a promise.
imagePath
Type: string
The path to the image to set as the desktop wallpaper.
options
Type: Object
screen (macOS only)
Type: string
number
Values: all
main
or the index of a screen from .screens()
Default: all
The screen to set the wallpaper on.
On Linux and Windows it's hard-coded to main
.
macOS only macOS and Windows
scale Type: string
Values: auto
fill
fit
stretch
center
tile
Default: fill
Scaling method.
.screens() (macOS only)
Returns a promise for the available screens.
async { await wallpaper; //=> ['Color LCD']};
Related
- macos-wallpaper - macOS binary used in this module
- winwallpaper - Windows binary used in this module
License
MIT © Tony Song