wallpaper

wallpaper

Get or set the desktop wallpaper

Works on macOS, Linux, and Windows.

Install

$ npm install wallpaper

Usage

const wallpaper = require('wallpaper');

(async () => {
	await wallpaper.set('unicorn.jpg');

	await wallpaper.get();
	//=> '/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

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.

scale (macOS only)

Type: string
Values: auto fill fit stretch center
Default: auto

Scaling method.

.screens() (macOS only)

Returns a promise for an array of screens.

(async () => {
	await wallpaper.screens();
	//=> ['Color LCD']
})();

Related

• 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

License

MIT © Sindre Sorhus