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

Export convenience functions separately #1177

Open
silvester-pari opened this issue Aug 5, 2024 · 0 comments
Open

Export convenience functions separately #1177

silvester-pari opened this issue Aug 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request map

Comments

@silvester-pari
Copy link
Collaborator

We have eox-map convenience functions which are not directly connected to the map. Currently, they are exported as eox-map properties, which doesn't make too much sense, it would be better to export them separately, so a user could do e.g.:

import { convenienceFunction} from "@eox/map"

const foo = convenienceFunction(bar)

List of current convenience functions:

  • parseFeature
  • parseTextToFeature
  • getFlatLayersArray
  • transform (WIP)
  • transformExtent (WIP)

Version strategy

Since removing these functions from the map properties would cause a breaking change we could do the following:

  • introduce convenience functions as separate exports in a v1.x with a deprecation note for the properties
  • remove properties with v2.x
@silvester-pari silvester-pari added documentation Improvements or additions to documentation enhancement New feature or request map labels Aug 5, 2024
@silvester-pari silvester-pari added this to the [eox-map] v2.0.0 milestone Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request map
Projects
None yet
Development

No branches or pull requests

1 participant