Typescript definitions

Problem

At the moment you can install Typescript 2.0 definitions via npm install @types/turf.

However, not all of the definitions are defined and it can be overwhelming trying to manage a 1280+ LOC type definition.

Solution

I’m suggesting we host the Typescript type definitions within the Turf library instead of DefinitelyTyped.

By including a simple & minimalistic index.d.ts and test/types.ts within each package, the type definitions will be bundled with each namespace package.

By default index.d.ts will be automatically detected, however including "types": "index.d.ts" in the package.json is a good practice.

/// <reference types="geojson" />

/***
 * http://turfjs.org/docs/#point
 */
export type Point = Array<number>
export function point(coordinates: Point, properties?: Object): GeoJSON.Feature<GeoJSON.Point>;

To-Do

• turf-along
• turf-area
• turf-bbox
• turf-bbox-polygon
• turf-bearing
• turf-bezier
• turf-buffer
• turf-center
• turf-center-of-mass
• turf-centroid
• turf-circle
• turf-collect
• turf-combine
• turf-concave
• turf-convex
• turf-destination
• turf-difference
• turf-distance
• turf-envelope
• turf-explode
• turf-flip
• turf-helpers
• turf-hex-grid
• turf-idw
• turf-inside
• turf-intersect
• turf-invariant
• turf-isolines
• turf-kinks
• turf-line-distance
• turf-line-slice
• turf-line-slice-along
• turf-meta
• turf-midpoint
• turf-nearest
• turf-planepoint
• turf-point-grid
• turf-point-on-line
• turf-point-on-surface
• turf-random
• turf-sample
• turf-simplify
• turf-square
• turf-square-grid
• turf-tag
• turf-tesselate
• turf-tin
• turf-triangle-grid
• turf-union
• turf-within

[bockoblur]

I don’t see anymore index.d.ts for the centroid package. Is this a missing ?

Any news on this? Just installed @turf/centroid 6.0.1 and types are missing…

[DenisCarriere]

🚀🚀 Woot! Completed all the Typescript definitions

packages/turf-along/index.d.ts
packages/turf-area/index.d.ts
packages/turf-bbox-polygon/index.d.ts
packages/turf-bbox/index.d.ts
packages/turf-bearing/index.d.ts
packages/turf-bezier/index.d.ts
packages/turf-buffer/index.d.ts
packages/turf-center-of-mass/index.d.ts
packages/turf-center/index.d.ts
packages/turf-centroid/index.d.ts
packages/turf-circle/index.d.ts
packages/turf-collect/index.d.ts
packages/turf-combine/index.d.ts
packages/turf-concave/index.d.ts
packages/turf-convex/index.d.ts
packages/turf-destination/index.d.ts
packages/turf-difference/index.d.ts
packages/turf-distance/index.d.ts
packages/turf-envelope/index.d.ts
packages/turf-explode/index.d.ts
packages/turf-flip/index.d.ts
packages/turf-helpers/index.d.ts
packages/turf-hex-grid/index.d.ts
packages/turf-idw/index.d.ts
packages/turf-inside/index.d.ts
packages/turf-intersect/index.d.ts
packages/turf-invariant/index.d.ts
packages/turf-isolines/index.d.ts
packages/turf-kinks/index.d.ts
packages/turf-line-distance/index.d.ts
packages/turf-line-slice-along/index.d.ts
packages/turf-line-slice/index.d.ts
packages/turf-meta/index.d.ts
packages/turf-midpoint/index.d.ts
packages/turf-nearest/index.d.ts
packages/turf-planepoint/index.d.ts
packages/turf-point-grid/index.d.ts
packages/turf-point-on-line/index.d.ts
packages/turf-point-on-surface/index.d.ts
packages/turf-random/index.d.ts
packages/turf-sample/index.d.ts
packages/turf-simplify/index.d.ts
packages/turf-square-grid/index.d.ts
packages/turf-square/index.d.ts
packages/turf-tag/index.d.ts
packages/turf-tesselate/index.d.ts
packages/turf-tin/index.d.ts
packages/turf-triangle-grid/index.d.ts
packages/turf-union/index.d.ts
packages/turf-within/index.d.ts