Niche Portobello Mushroom

    @resoc/create-img
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.1 • Public • Published

    @resoc/create-img

    Use this package to turn a template and parameter values to an image.

    Install:

    npm install @resoc/create-img

    Then, create an image:

    createImage(
      'path/to/resoc.manifest.json',
      {
        title: "A picture is worth a thousand words",
        textColor: "#ffffff"
      },
      {
        width: 1200,
        height: 630
      },
      'path/to/output.jpg'
    );

    Configure Puppeteer

    Puppeteer is used under the hood to generate images. You need to configure it depending on your environment.

    Most environments

    In most environments, Puppeteer can be used directly. All you need is to install it:

    npm install puppeteer

    Resoc will just find it and use it.

    AWS Lambda & Netlify

    Due to tight memory constraints, certain environments cannot use Puppeteer as is.

    Install:

    npm install puppeteer-core chrome-aws-lambda

    Then, instanciate the browser yourself:

    const chromium = require('chrome-aws-lambda');
    
    const browser = await chromium.puppeteer.launch({
      executablePath: await chromium.executablePath,
      args: chromium.args,
      headless: chromium.headless
    });
    
    createImage(
      'path/to/resoc.manifest.json',
      {
        title: "A picture is worth a thousand words",
        textColor: "#ffffff"
      },
      { width: 1200, height: 630 },
      'path/to/output.jpg',
      { browser }
    );

    Install

    npm i @resoc/create-img

    DownloadsWeekly Downloads

    133

    Version

    0.9.1

    License

    MIT

    Unpacked Size

    20.5 kB

    Total Files

    11

    Last publish

    Collaborators

    • phbernard