Get or set the desktop wallpaper
Works on macOS 10.12+, Linux, and Windows 10+.
Maintainer needed for the Linux part of the code. No new Linux-related changes will be accepted until someone with good Linux knowledge volunteers.
$ npm install wallpaper
const wallpaper = require('wallpaper');
(async () => {
await wallpaper.set('unicorn.jpg');
await wallpaper.get();
//=> '/Users/sindresorhus/unicorn.jpg'
})();Returns a Promise<string> with the path of the current desktop wallpaper.
Type: object
Type: string | number
Values: 'all', 'main', or the index of a screen from .screens()
Default: 'main'
The screen to get the wallpaper from.
If you set 'all' then .get() will return a Promise<string[]>.
Returns a Promise.
Type: string
The path to the image to set as the desktop wallpaper.
Type: object
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'.
Type: string
Values: 'auto' | 'fill' | 'fit' | 'stretch' | 'center'
Default: 'auto'
Scaling method.
Returns a Promise<string[]> with the available screens.
(async () => {
await wallpaper.screens();
//=> ['Color LCD']
})();- wallpaper-cli - CLI for this module
- macos-wallpaper - macOS binary used in this module
- win-wallpaper - Windows binary used in this module
- trash - Move files and directories to the trash