npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

wallpaper

4.4.0 • Public • Published

wallpaper Build Status Build status

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.

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

The 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 the available screens.

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

Related

License

MIT © Sindre Sorhus

install

npm i wallpaper

Downloadsweekly downloads

276

version

4.4.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability