7.1.0 • Published 3 months ago

@turf/invariant v7.1.0

Weekly downloads
627,281
License
MIT
Repository
github
Last release
3 months ago

@turf/invariant

getCoord

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

getCoords

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

containsNumber

Checks if coordinates contains a number

Parameters

  • coordinates Array<any> GeoJSON Coordinates

Returns boolean true if Array contains a number

geojsonType

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.

featureOf

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.

collectionOf

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.

getGeom

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]}
  • Throws Error if geojson is not a Feature or Geometry Object

Returns (Geometry | null) GeoJSON Geometry Object

getGeomType

Get Geometry Type from Feature or Geometry Object

  • Throws Error DEPRECATED in v5.0.0 in favor of getType

getType

Get GeoJSON object's type, Geometry type is prioritize.

Parameters

  • geojson GeoJSON GeoJSON object
  • name 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.

Installation

Install this module individually:

$ npm install @turf/invariant

Or install the Turf module that includes it as a function:

$ npm install @turf/turf
@bimenergy/be-format-utilsregen-components@infinitebrahmanuniverse/nolb-_tur@hopara/hopara@everything-registry/sub-chunk-941flow-rdfgas.glgas3d.glleaflet-draw-cutmilafrerichs-turf-intersectmilafrerichs-turf-square-gridmini-tokyo-3dlocation-map-imageosmlinterjd-tessmap-common-utilsmapbox-map-toolmapbox-gl-draw-snap-on-mode@ifanrx/uni-mp@loudsrl/concave@loudsrl/turf@giscience/ohsome2x@jhgrrewq/l7-source@kylebarron/snap-features-to-tin@terascope/utilsexample-eez-twoexample-project-worldexample-project-fiveexample-project-fooexample-project-samoaexample-project-subexample-project-threepolygonizegrid-to-matrixreact-mapbox-gl-clusterrectangle-gridtemp-turf-rectangle-gridsharedstreetsshinegis-client@carto/api-client@cgcs2000/l7-sourcewithin-canada@antv/l7-source@any-routing/annotation-plugin@bmap-turf/turf@turf/line-offsetturf-pointgriddensityturf-polygon-sliceturf-voronoi-delaunayunl-corevin3box@emuanalytics/flow-rdf@emuanalytics/flow-rdf-core@emuanalytics/flow-rdf-core-test@donmccurdy/center-of-mass@turf/nearest-point-on-line@turf/nearest-point-to-line@turf/planepoint@turf/point-grid@turf/rhumb-destination@turf/rhumb-distance@turf/sector@turf/shortest-path@turf/standard-deviational-ellipse@turf/transform-rotate@turf/transform-scale@turf/concave@turf/destination@turf/directional-mean@turf/dissolve@turf/distance@turf/distance-weight@turf/ellipse@turf/point-on-line@turf/point-to-line-distance@turf/polygon-tangents@turf/polygon-to-line@turf/polygon-to-linestring@turf/polygonize@turf/quadrat-analysis@turf/rewind@turf/rhumb-bearing@turf/great-circle@turf/hex-grid@turf/inside@turf/interpolate@turf/isobands@turf/isolines@turf/line-overlap@turf/line-segment@turf/line-slice@turf/line-split@turf/line-to-polygon@turf/linestring-to-polygon@turf/center-of-mass@turf/clean-coords@turf/clusters-kmeans@turf/along@turf/angle@turf/bbox-clip
7.1.0

3 months ago

7.1.0-alpha.70

3 months ago

7.0.0

5 months ago

7.1.0-alpha.7

4 months ago

7.0.0-alpha.116

6 months ago

7.0.0-alpha.115

6 months ago

7.0.0-alpha.114

8 months ago

7.0.0-alpha.113

9 months ago

7.0.0-alpha.111

10 months ago

7.0.0-alpha.110

10 months ago

7.0.0-alpha.1

1 year ago

7.0.0-alpha.2

1 year ago

7.0.0-alpha.0

2 years ago

6.5.0

3 years ago

6.4.0

3 years ago

6.3.0

4 years ago

6.2.0

4 years ago

6.2.0-alpha.3

4 years ago

6.2.0-alpha.2

4 years ago

6.2.0-alpha.0

5 years ago

6.2.0-alpha.1

5 years ago

6.1.2

6 years ago

6.0.1

7 years ago

6.0.0

7 years ago

6.0.0-beta.4

7 years ago

6.0.0-beta.3

7 years ago

6.0.0-beta.2

7 years ago

5.2.0

7 years ago

5.1.5

7 years ago

5.1.4

7 years ago

5.1.0

7 years ago

5.0.4

7 years ago

5.0.0

7 years ago

5.0.0-alpha

7 years ago

4.7.3

7 years ago

4.7.1

7 years ago

4.7.0

7 years ago

4.6.0

7 years ago

4.5.2

7 years ago

4.5.1

7 years ago

4.4.0

7 years ago

4.3.0

7 years ago

4.2.0

8 years ago

4.1.0

8 years ago

4.0.1

8 years ago

4.0.0

8 years ago

3.13.0

8 years ago

3.10.0

8 years ago

3.7.5

8 years ago

3.7.3

8 years ago

3.7.0

8 years ago

3.6.3

8 years ago

3.5.2

8 years ago

3.3.3

8 years ago

3.0.16

8 years ago

3.0.15

8 years ago