@fa7ad/wallpaper

2.4.2-a • Public • Published

wallpaper Build Status Build status

Get or set the desktop wallpaper

Works on macOS, Linux, and Windows.

Install

$ npm install --save @fa7ad/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

License

MIT © Sindre Sorhus

Dependencies (1)

Dev Dependencies (2)

Package Sidebar

Install

npm i @fa7ad/wallpaper

Weekly Downloads

0

Version

2.4.2-a

License

MIT

Last publish

Collaborators

  • fa7ad