Example Error

[angrykoala]

Running your example:

const wallpaper = require('wallpaper');

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

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

On Linux Ubuntu throws an error on /lib/linux.js:

return cp.execFile(app.cmd, app.get).then(stdout => 

TypeError: Cannot read property 'cmd' of undefined

Seems to be due to using async functions (get and set) at the same time (same problem with different error if using get before set

The problem solves simply using the second command inside the callback:

const wallpaper = require('wallpaper');

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

I'm not sure if the problem is just in linux, and if its an error in the example code or in the linux library.

[kevva]

The example is just meant to show how you use the methods individually and what they return. It assumes that people know about async.

[angrykoala]

Wouldn't be better to use 2 different examples? just for better clarity.

[kevva]

Both @sindresorhus, me and tons of authors are doing examples like this in many (small) modules. It's somewhat expected that users have some knowledge about how async works :). I.e, doing two async operations at the same time that depends on each other will mostly break.

[SamVerschueren]

Agree with @kevva , no need to change it.

[kevva]

Also, what if you expose more than two methods? To separate all those into their own examples would only clutter the documentation.

[angrykoala]

If making more examples is a problem, simply by splitting the example code would show to a new user it is not meant to work with copy-paste:

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

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

It is not a big deal, but it may make the example a little bit more clear to people who just want a first "Hello World" to try

[kevva]

That's what I meant by cluttering the docs.

[angrykoala]

well... it's one white line, but ok.It was just an idea