Set centered param default to True
#836
Conversation
simplified tests; updated all relevant files;
packages/turf-point-grid/index.d.ts
Outdated
| @@ -3,6 +3,6 @@ import {BBox, Points, Units, Feature, Features} from '@turf/helpers'; | |||
| /** | |||
| * http://turfjs.org/docs/#pointgrid | |||
| */ | |||
| declare function pointGrid(bbox: BBox | Feature<any> | Features<any>, cellSide: number, units?: Units, centered?: boolean, bboxIsMask?: boolean): Points; | |||
| declare function pointGrid(bbox: BBox | Feature<any> | Array<number>, cellSide: number, units?: Units, centered?: boolean, bboxIsMask?: boolean): Points; | |||
There was a problem hiding this comment.
-
Why the removal of
Features<any>this is to support FeatureCollection, I guess we should use the full name of the Type (FeatureCollection<any>) instead of making the types plural. -
BBox is already defined -
Array<number>is not needed
BBox => [number, number, number, number]
CC: @stebogit
There was a problem hiding this comment.
I need to take some time and update all the Typescript definitions for each module (all 85 of them.. 😱) make them all consistent.
There was a problem hiding this comment.
@DenisCarriere it'd be nice if we had some kind of types file (TYPES.md?) maybe in the root as reference for all Turf modules. With that I could help updating all the modules and would be useful, when creating new models, for who like me doesn't know typescript
There was a problem hiding this comment.
That would be a good idea, maybe I'll create that before updating all the definitions.
My approach to Typescript is not as strict as others like DefinitelyTyped which enforce strict linting (don't think we are there yet for TurfJS - might add a basic TS linting config).
Fixes #833.
@DenisCarriere I added a note in the doc that notify/warn the user that
centeredwill be dropped in the next major release, to try to discourage its use.Is that ok?