@turf/invariant
Advanced tools
@turf/invariant is a module within the Turf.js library that provides utility functions for validating and extracting GeoJSON objects. It ensures that the input data conforms to the expected GeoJSON format, which is crucial for performing various geospatial operations.
getCoord
The `getCoord` function extracts the coordinates from a GeoJSON Point feature. This is useful when you need to work directly with the coordinates of a point.
const turf = require('@turf/invariant');
const point = { type: 'Feature', geometry: { type: 'Point', coordinates: [102.0, 0.5] } };
const coord = turf.getCoord(point);
console.log(coord); // [102.0, 0.5]getCoords
The `getCoords` function extracts the coordinates from a GeoJSON LineString or Polygon feature. This is useful for accessing the array of coordinates that make up the geometry.
const turf = require('@turf/invariant');
const line = { type: 'Feature', geometry: { type: 'LineString', coordinates: [[102.0, 0.0], [103.0, 1.0]] } };
const coords = turf.getCoords(line);
console.log(coords); // [[102.0, 0.0], [103.0, 1.0]]getGeom
The `getGeom` function extracts the geometry object from a GeoJSON feature. This is useful when you need to work with the geometry independently of the feature properties.
const turf = require('@turf/invariant');
const feature = { type: 'Feature', geometry: { type: 'Polygon', coordinates: [[[102.0, 0.0], [103.0, 1.0], [104.0, 0.0], [102.0, 0.0]]] } };
const geom = turf.getGeom(feature);
console.log(geom); // { type: 'Polygon', coordinates: [[[102.0, 0.0], [103.0, 1.0], [104.0, 0.0], [102.0, 0.0]]] }getType
The `getType` function returns the type of a GeoJSON object. This is useful for validating the type of geometry you are working with.
const turf = require('@turf/invariant');
const feature = { type: 'Feature', geometry: { type: 'Polygon', coordinates: [[[102.0, 0.0], [103.0, 1.0], [104.0, 0.0], [102.0, 0.0]]] } };
const type = turf.getType(feature);
console.log(type); // 'Polygon'The `geojson-validation` package provides functions to validate GeoJSON objects against the GeoJSON specification. It is similar to @turf/invariant in that it ensures the input data conforms to the expected GeoJSON format, but it focuses more on validation rather than extraction of specific components.
The `geojson-utils` package offers a set of utility functions for working with GeoJSON data, including validation, distance calculations, and bounding box operations. It provides broader functionality compared to @turf/invariant, which is more focused on validation and extraction.
Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
Parameters
Examples
var pt = turf.point([10, 10]);
var coord = turf.getCoord(pt);
//= [10, 10]
Returns Array<number> coordinates
Unwrap coordinates from a Feature, Geometry Object or an Array
Parameters
Examples
var poly = turf.polygon([[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]);
var coords = turf.getCoords(poly);
//= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
Returns Array<any> coordinates
Checks if coordinates contains a number
Parameters
coordinates Array<any> GeoJSON CoordinatesReturns boolean true if Array contains a number
Enforce expectations about types of GeoJSON objects for Turf.
Parameters
value GeoJSON any GeoJSON object
type string expected GeoJSON type
name string name of calling function
Throws Error if value is not the expected type.
Enforce expectations about types of Feature inputs for Turf. Internally this uses geojsonType to judge geometry types.
Parameters
feature Feature a feature with an expected geometry type
type string expected GeoJSON type
name string name of calling function
Throws Error error if value is not the expected type.
Enforce expectations about types of FeatureCollection inputs for Turf. Internally this uses geojsonType to judge geometry types.
Parameters
featureCollection FeatureCollection a FeatureCollection for which features will be judged
type string expected GeoJSON type
name string name of calling function
Throws Error if value is not the expected type.
Get Geometry from Feature or Geometry Object
Parameters
Examples
var point = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [110, 40]
}
}
var geom = turf.getGeom(point)
//={"type": "Point", "coordinates": [110, 40]}
Returns (Geometry | null) GeoJSON Geometry Object
Get Geometry Type from Feature or Geometry Object
Get GeoJSON object's type, Geometry type is prioritize.
Parameters
geojson GeoJSON GeoJSON objectname string name of the variable to display in error message (optional, default "geojson")Examples
var point = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [110, 40]
}
}
var geom = turf.getType(point)
//="Point"
Returns string GeoJSON type
This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.
Install this module individually:
$ npm install @turf/invariant
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
6.5.0
@turf/points-with-polygon Add MultiPoint support
(PR https://github.com/Turfjs/turf/pull/2137 - Author @twelch)@turf/dissolve Complete rewrite of the dissolve module to resolve many bugs
(PR https://github.com/Turfjs/turf/pull/2110 - Author @rowanwins)
@turf/mask Complete rewrite of the mask module to resolve many bugs
(PR https://github.com/Turfjs/turf/pull/2130 - Author @rowanwins)
@turf/boolean-valid Add missing dependency to
(PR https://github.com/Turfjs/turf/pull/2094 - Author @rycgar)
@turf/boolean-overlap Improve clarity
(PR https://github.com/Turfjs/turf/pull/2133 - Author @patrickbrett)FAQs
turf invariant module
The npm package @turf/invariant receives a total of 0 weekly downloads. As such, @turf/invariant popularity was classified as not popular.
We found that @turf/invariant demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.