@mapmap/tile reference

Generated from the published @mapmap/tile 0.1.0 type declarations by website/scripts/sdk-reference.mjs. Do not edit by hand: change the JSDoc in the package, or the examples in website/content/sdk-reference/tile.examples.md, and regenerate.

Every public export of the GeoJSON-to-PMTiles tiler, in the browser and in Node. The command line (mapmap-tile) is described in SDKs & installation.

npm install @mapmap/tile@0.1.0

Other SDK references: @mapmap/maps, @mapmap/points, @mapmap/core, @mapmap/react-native, @mapmap/voice, MapMapKit, ai.mapmap:core.

8 exports across 1 entry point: 4 functions, 3 interfaces, 1 type.

How to read this page

Each entry gives the declaration as published, the JSDoc description, and a table of parameters or properties with their types. The Default column quotes the default the source states (an @default tag or a "Default ..." sentence in the JSDoc). "required" means the property must be given; "not stated" means the source gives no default, so none is claimed here. Classes, factories and the main entry functions each carry a minimal example; examples marked from the source are the package's own @example.

Contents

• @mapmap/tile: 8 exports

@mapmap/tile

import { /* … */ } from "@mapmap/tile";

Functions (@mapmap/tile)

init, tile, tileWithReport, version

init

Function

function init(moduleOrPath?: string | URL | Response | WebAssembly.Module): Promise<unknown>;

Load the WASM (browser only; a no-op in Node). tile calls it for you.

Example

import { init, version } from "@mapmap/tile";

// Optional: tile() loads the WASM itself. Call init() first to load it early, or to read version().
await init();
console.log(version());

tile

Function

function tile(input: TileInput, options?: TileOptions): Promise<Uint8Array>;

Tile GeoJSON into a .pmtiles archive. Rejects with an Error naming the problem.

Options and types: TileInput, TileOptions.

Example

import { tile } from "@mapmap/tile";

const geojson = await (await fetch("/sites.geojson")).text();
const archive = await tile(geojson, { layer: "sites", maxzoom: 12, attribution: "© OpenStreetMap contributors" });
const url = URL.createObjectURL(new Blob([archive as BlobPart], { type: "application/vnd.pmtiles" }));
console.log(url);

tileWithReport

Function

function tileWithReport(input: TileInput, options?: TileOptions): Promise<{
    archive: Uint8Array;
    report: TileReport;
}>;

As tile, with the counts the CLI prints.

Options and types: TileInput, TileOptions.

Example

import { tileWithReport } from "@mapmap/tile";

const { archive, report } = await tileWithReport('{"type":"FeatureCollection","features":[]}', {
  onProgress: (p) => console.log(`zoom ${p.zoom}: ${p.tiles} tiles`),
});
console.log(report.features, report.tiles, report.bounds, archive.byteLength);

version

Function

function version(): string;

The package version. In the browser, call after init().

Interfaces (@mapmap/tile)

TileOptions, TileProgress, TileReport

TileOptions

Interface

interface TileOptions

TileProgress

Interface

interface TileProgress

Progress after each zoom level.

TileReport

Interface

interface TileReport

Types (@mapmap/tile)

TileInput

TileInput

Type

type TileInput = string | Uint8Array | ArrayBuffer | ArrayBufferView;

GeoJSON or GeoJSON Lines, as text or UTF-8 bytes.