gis-tools-ts/dist/readers/shapefile/index.d.ts

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

import { ShapeFileReader } from './shp.js';
import type { ProjectionTransformDefinition } from '../../proj4/index.js';
export * from './dbf.js';
export * from './shp.js';
/**
 * # Read a Shapefile from a Gzip folder.
 *
 * ## Description
 * Assumes the input is an arraybuffer that is pointing to a collection of zip shapefile data.
 *
 * ## Usage
 * ```ts
 * import { shapefileFromGzip, LambertConformalConic, EPSG_9974 } from 'gis-tools-ts';
 *
 * const reader = await shapefileFromGzip(arrayBufferInput, [LambertConformalConic], { EPSG_9974 });
 *
 * for await (const feature of reader) {
 *   console.log(feature);
 * }
 * ```
 * @param input - raw buffer of gzipped data (folder of shp, dbf, prj, and/or cpg)
 * @param defs - optional array of ProjectionTransformDefinitions to insert
 * @param epsgCodes - a record of EPSG codes to use for the transformer if needed
 * @returns - a Shapefile
 */
export declare function shapefileFromGzip(input: ArrayBufferLike, defs?: ProjectionTransformDefinition[], epsgCodes?: Record<string, string>): Promise<ShapeFileReader>;
/**
 * # Read a Shapefile from a URL.
 *
 * ## Description
 * Assumes the input is pointing to shapefile data or a gzipped folder with .shp, .dbf, .prj, and/or .cpg
 *
 * ## Usage
 * ```ts
 * import { shapefileFromURL, LambertConformalConic, EPSG_9974 } from 'gis-tools-ts';
 *
 * const reader = await shapefileFromURL('https://example.com/data.zip', [LambertConformalConic], { EPSG_9974 });
 *
 * for await (const feature of reader) {
 *   console.log(feature);
 * }
 * ```
 * @param url - the url to the shapefile
 * @param defs - optional array of ProjectionTransformDefinitions to insert
 * @param epsgCodes - a record of EPSG codes to use for the transformer if needed
 * @returns - a Shapefile
 */
export declare function shapefileFromURL(url: string, defs?: ProjectionTransformDefinition[], epsgCodes?: Record<string, string>): Promise<ShapeFileReader>;
//# sourceMappingURL=index.d.ts.map