@zerox-dg/wallpaper

wallpaper

Get or set the desktop wallpaper

Works on macOS, Linux, and Windows.

Install

$ npm install @zerox-dg/wallpaper

Usage

const wallpaper = require("wallpaper");

wallpaper.set("unicorn.jpg").then(() => {
	console.log("done");
});

wallpaper.get().then(imagePath => {
	console.log(imagePath);
	//=> '/Users/sindresorhus/unicorn.jpg'
});

API

.get()

Returns a promise for the path of the current desktop wallpaper.

.set(imagePath, [options])

Returns a promise.

imagePath

Type: string

Path to the image to set as the desktop wallpaper.

options

Type: Object

scale

Type: string
Values: fill fit stretch center
Default: Current system setting

Scaling method. Only available on macOS.

Related

• wallpaper-cli - CLI for this module
• macos-wallpaper - macOS binary used in this module
• win-wallpaper - Windows binary used in this module

License

MIT © Sindre Sorhus