Tighten up typedef of properties option in polygonToLine
Open
Nobody has claimed this yet.
next-major-release
typescript
- Dominant language
- TypeScript
- Stars
- 10.5k
- Forks
- 1k
- Avg merge
- 1h 11m
- Merged PRs (30d)
- 4
Description
The properties option of polygonToLine is defined as any. Should really be GeoJsonProperties. Less permissive than current API though so will need to wait for a major release.
v7.2.0
Please provide the following when reporting an issue:
- Description of the problem, and how it differs from what you expected.
- Version of Turf you are using, and of any other relevant software.
- Confirmation this issue hasn't already been reported, or is resolved and just hasn't been released yet.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the TypeScript definition or entry point for polygonToLine and inspect how its properties option is typed. Confirm the appropriate GeoJsonProperties type used by the project, then update the typedef and verify the resulting public API type; the issue notes that release timing is constrained by a major version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100