Examples don't work as presented from node

[pg1671]

The 2 examples on the main page did not work as presented for me running under node.js.

1. I had to upgrade to node13, can you make a note of this or the experimental modules command line option.
2. I had to make the calling code a module by renaming to mjs.
3. When importing renderSocialImage it is not a function you can call directly and you need to call the default function.

I don't use node.js often so I may have missed something.

[chrisvxd]

Hey @pg1671. Thanks for the ticket.

This sounds like an ES6 module loading problem, which is probably due to the way I'm building the library. I take it you're not using Babel or a bundler.

The examples are using import X from 'Y';, an example of the ES6 module system. This has only just landed in Node 13 as an experimental feature, but many developers in the Node community use a compiler like Babel to support this in older version. The docs are written with an assumption of this prior knowledge, but perhaps that needs adjusting.

If you don't want to use a compiler, you can be use require (aka Common JS) and point to the default param, as you've discovered. This should work in older versions of Node (I use 10) and you shouldn't need to rename the file to a "module".

const renderSocialImage = require("puppeteer-social-image").default;

renderSocialImage({
  template: "basic",
  templateParams: {
    imageUrl:
      "https://images.unsplash.com/photo-1557958114-3d2440207108?w=1950&q=80",
    title: "Hello, world"
  },
  output: "image.png",
  size: "facebook"
});

Let me know if that works.

It also wouldn't be complicated for me to patch the build output and switch the examples to CommonJS, which would then remove the need to add default:

const renderSocialImage = require("puppeteer-social-image");

[audiolion]

no idea why but using node 14.1.0 with "type": "module" and a .js file, my es module import still had to call .default