Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

running list of refactored modules #106

Closed
53 tasks done
morganherlocker opened this issue Apr 12, 2014 · 7 comments
Closed
53 tasks done

running list of refactored modules #106

morganherlocker opened this issue Apr 12, 2014 · 7 comments

Comments

@morganherlocker
Copy link
Member

Break out each function into its own submodule. This might take a while, but the general idea is to start with the most basic functions that are depended upon the most and move up the chain. Eventually all turf functions will be separated and turf will mostly just be a document describing an overarching geoscripting api. At that point, usage might look something like this:

var turf = {}
turf.buffer = require('turf-buffer')
turf.merge = require('turf-merge')

var pts = // set of points

// buffer points
var buffered = turf.buffer(pts, 1, 'miles')
// merge the rings
var merged = turf.merge(buffered)

// do something with the merged polygon(s)

The following modules have been released:

  • isClockwise
  • isolines
  • isobands
  • merge
  • convex
  • donuts
  • within
  • concave
  • count
  • erase
  • variance
  • deviation
  • median
  • min
  • max
  • aggregate
  • flip
  • simplify
  • sum
  • average
  • topo
  • bezier
  • tag
  • size
  • sample
  • jenks
  • quantile
  • envelope
  • square
  • midpoint
  • buffer
  • center
  • centroid
  • combine
  • distance
  • explode
  • extent
  • bboxPolygon
  • featurecollection
  • filter
  • grid
  • inside
  • intersect
  • linestring
  • nearest
  • planepoint
  • point
  • polygon
  • quantile
  • reclass
  • remove
  • tin
  • union
@morganherlocker
Copy link
Member Author

save and load are being removed (redundant with fs, and do not work in browser). area and near do not actually exist yet, so they are left off for now.

@morganherlocker
Copy link
Member Author

I am leaving jsts alone for now so that we can ship a 0.2. Removing jsts will be a top priority after the big release after docs are updated.

@tmcw
Copy link
Collaborator

tmcw commented May 29, 2014

I've split out everything that doesn't depend on turf-buffer.

@morganherlocker
Copy link
Member Author

fyi: turf-buffer is published now.

@tmcw
Copy link
Collaborator

tmcw commented May 29, 2014

👍 this list is complete. tasks for individual modules are split out - a few need lodash-removal and not all are in the org / have travis set up

@morganherlocker
Copy link
Member Author

All modules have been added to the org.

@morganherlocker
Copy link
Member Author

All modules have been documented and integrated into turf main, so I am closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants