The primary goal of this package is to seamlessly replace our internal library. It's based on the osm-static-maps package. Emphasizing speed and safety. This ensures a swift and efficient performance in alignment with our project requirements.

Render mode

The render works by using puppeteer to render the map and then save the image to the disk or returning it encoded using cbor. To be memory and cpu efficient only one instance of the browser is created and a tab is created for each render request.

sequenceDiagram
    participant Your code
    participant OSM
    
    OSM->>OSM: Start the browser
    loop Call the function when you need it
        Your code->>OSM: Call render function
        activate OSM
        OSM->>OSM: Save file
        OSM-->>Your code: Response
    end
    deactivate OSM

Work mode

There are two modes of operation.

[!IMPORTANT]
At the moment it is only designed to be used on the same server that needs the images, that is the reason why it saves the screenshots directly to the disk, then you can move them wherever you want.

Library mode: You use it on your code and call the render function.

/// ESM import
import { render } from 'open-static-maps';
/// CJS import
const { render } = require('open-static-maps');

render({
    width: 600,
    height: 400,
    provider: 'osm',
    output: 'buenos-aires.png',
});

Server mode: You start the server and make http requests to it.

/// ESM import
import { render } from 'open-static-maps';
/// CJS import
const { render } = require('open-static-maps');

render({
    width: 600,
    height: 400,
    provider: 'osm',
    output: 'buenos-aires.png',
});

sequenceDiagram
    participant HttpClient
    participant OSM
    
    OSM->>OSM: Start the browser
    loop Call the function when you need it
        HttpClient->>OSM: Http render request
        activate OSM
        OSM->>OSM: Save file
        OSM-->>HttpClient: Response
    end
    deactivate OSM

| Parameter | Type | Required | Description | Default | |-----------|---------|----------|-------------|---------| | width | number | :x: | Width of the image in pixels. | 110 | | height | number | :x: | Height of the image in pixels. | 61 | | outputFile| string | :heavy_check_mark: |Path to the output file. | undefined | | provider | OSM|CARTODB|CARTODB_LIGHT|CARTODB_DARK | :x: | Map provider. | CARTODB |

Feature requests

Feel free to open an issue if you have a feature request.

TODO

• [ ] Support for png and webp formats
• [ ] Serve images
• [ ] Output to buffer
• [ ] More providers
• [ ] More map renderers
• [ ] Geojson support
• [ ] Limit the number of concurrent renders or use a queue