gdal3.js/src/index.d.ts

gdal3.js is a port of Gdal applications (**gdal_translate**, **ogr2ogr**, **gdal_rasterize**, **gdalwarp**, **gdaltransform**) to Webassembly. It allows you to convert raster and vector geospatial data to various formats and coordinate systems.

interface FileInfo {
    path: string;
    size: number;
}

interface FilePath {
    local: string;
    real: string;
    all?: FilePath;
}

interface Dataset {
    pointer: number;
    path: string;
    type: string;
    info: object;
}

interface DatasetList {
    datasets: Array<Dataset>;
    errors: Array<string>;
}

interface Layer {
    name: string;
    featureCount: number;
}

interface DatasetInfo {
    type: string;
    dsName: string;
    driverName: string;
    bandCount?: number;
    width?: number;
    height?: number;
    projectionWkt?: string;
    coordinateTransform?: Array<number>;
    corners?: Array<Array<number>>;
    layerCount?: number;
    featureCount?: number;
    layers?: Array<Layer>;
}

interface LocationInfo{
    pixel: number;
    line: number;
}

interface Drivers {
    raster: Object;
    vector: Object;
}

interface Gdal {
    ogr2ogr(dataset: Dataset, options?: Array<string>, outputName?: string): Promise<FilePath>;
    gdal_translate(dataset: Dataset, options?: Array<string>, outputName?: string): Promise<FilePath>;
    gdal_rasterize(dataset: Dataset, options?: Array<string>, outputName?: string): Promise<FilePath>;
    gdalwarp(dataset: Dataset, options?: Array<string>, outputName?: string): Promise<FilePath>;
    gdaltransform(coords: Array<Array<number>>, options: Array<string>): Promise<Array<Array<number>>>;
    gdalinfo(dataset: Dataset, options?: Array<string>): Promise<object>;
    ogrinfo(dataset: Dataset, options?: Array<string>): Promise<object>;
    open(fileOrFiles: FileList|File|Array<string>|string, options?: Array<string>, VFSHandlers?: Array<string>): Promise<DatasetList>;
    close(dataset: Dataset): Promise<void>;
    getInfo(dataset: Dataset): Promise<DatasetInfo>;
    getOutputFiles(): Promise<Array<FileInfo>>;
    getFileBytes(filePath: string|FilePath): Promise<Uint8Array>;
    drivers: Drivers;
    gdal_location_info: Promise<LocationInfo>;
}

interface GdalFilePaths {
    wasm: string;
    data: string;
    js?: string;
}

interface Config {
    path?: string;
    paths?: GdalFilePaths
    dest?: string;
    useWorker?: boolean;
    env?: object;
    logHandler?: (message: string, type: string) => void;
    errorHandler?: (message: string, type: string) => void;
}

declare module 'gdal3.js' {
    export default function initGdalJs(config?: Config): Promise<Gdal>;
}