@types/topojson-client

What is @types/topojson-client?

@types/topojson-client provides TypeScript type definitions for the topojson-client library, which is used for manipulating and converting TopoJSON data. TopoJSON is an extension of GeoJSON that encodes topology, allowing for more efficient data storage and enabling operations like topology-preserving simplification and merging of shapes.

What are @types/topojson-client's main functionalities?

topojson.feature

Converts a TopoJSON object into a GeoJSON Feature or FeatureCollection. This is useful for rendering or further processing the data in libraries that expect GeoJSON.

const topojson = require('topojson-client');
const topology = { /* TopoJSON data */ };
const geojson = topojson.feature(topology, topology.objects.myObject);

topojson.mesh

Extracts the mesh (lines) from a TopoJSON object, which can be used to render boundaries or other linear features.

const topojson = require('topojson-client');
const topology = { /* TopoJSON data */ };
const mesh = topojson.mesh(topology, topology.objects.myObject);

topojson.merge

Merges multiple TopoJSON geometries into a single geometry, preserving topology. This is useful for combining adjacent shapes into a single shape.

const topojson = require('topojson-client');
const topology = { /* TopoJSON data */ };
const merged = topojson.merge(topology, topology.objects.myObject.geometries);

Other packages similar to @types/topojson-client

geojson

The geojson package provides utilities for working with GeoJSON data. Unlike topojson-client, it does not handle TopoJSON data, which includes topology information. It is more suitable for applications that only need to work with GeoJSON.

d3-geo

d3-geo is part of the D3.js library and provides geographic projections and utilities for working with GeoJSON data. It does not handle TopoJSON directly but can be used in conjunction with topojson-client for rendering and manipulating geographic data.

shapefile

The shapefile package is used for reading and writing ESRI Shapefiles, which are another common format for geographic data. It does not handle TopoJSON or GeoJSON directly but can be used to convert Shapefiles to these formats.

README

Installation

npm install --save @types/topojson-client

Summary

This package contains type definitions for topojson-client (https://github.com/topojson/topojson-client).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/topojson-client.

Additional Details

• Last updated: Mon, 16 Sep 2024 16:08:34 GMT
• Dependencies: @types/geojson, @types/topojson-specification

Credits

These definitions were written by denisname, and Ricardo Mello.