Get or set the desktop wallpaper
Works on macOS 10.14.4+.
npm install macos-wallpaper
import {getWallpaper, setWallpaper} from 'wallpaper';
await setWallpaper('unicorn.jpg');
await getWallpaper();
//=> '/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 getWallpaper()
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.
Type: string
Values: 'auto' | 'fill' | 'fit' | 'stretch' | 'center'
Default: 'auto'
Type: string
The color to set as a RGB Hex value. For example, 000000
for black.
Scaling method.
Returns a Promise
.
Type: string
The color to set as a RGB Hex value. For example, 000000
for black.
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.
import {setSolidColorWallpaper} from 'wallpaper';
await setSolidColorWallpaper('000000');
Returns a Promise<string[]>
with the available screens.
import {screens} from 'wallpaper';
await screens();
//=> ['Color LCD']
- macos-wallpaper - macOS binary used in this module