DOCS · INDEX
Documentation
Everything is organised around three doors: guides for concepts, the API reference for lookups, and recipes you can paste. Start with getting started; come back for the rest.
Guides
START HERE
Getting started
Install, wire your bundler, convert your first file: browser, Node, React Native.
GUIDE
Configuration
initCppJs options, GDAL config options, PROJ data path, raster cache.
GUIDE
Architecture & internals
How C++ headers become JS modules; wasm on the web, JSI on mobile.
GUIDE
Workers & threading
useWorker, single- vs multi-threaded builds, cross-origin isolation.
GUIDE
Memory management
Closing datasets, GDAL's block cache, browser memory limits.
GUIDE
Virtual file system
OPFS, /vsimem/, /vsizip/, and where your output actually goes.
GUIDE
Error handling
Reading GDAL's error state and decoding the most common messages.
GUIDE
Optimization
First-load cost, caching, keeping the UI thread free.
INTEGRATIONS
Frameworks & bundlers
Vite, Webpack, Rollup, Rspack, Metro (React Native & Expo), Node.
COOKBOOK
Recipes & examples
Convert, reproject, mosaic, hillshade: working snippets.
Reference
REFERENCE
API reference
initCppJs, Module helpers, and the Gdal / Dataset / Driver / GCP classes.
REFERENCE
Supported formats
The driver registry: what reads, what writes.
REFERENCE
Changelog
Releases and notable merged PRs, v2 and v3.