search

ionic-team / capacitor-google-maps

12 stars 16 forks source link

`removeMarkers()`: where does the `id` come from? #10

Open frederikheld opened 3 months ago

frederikheld commented 3 months ago

Bug Report

Not necessarily a bug, but not properly documented

Plugin(s)

@capacitor/google-maps@next

Capacitor Version

6.0.0

Platform(s)

JS

Current Behavior

removeMarkers() expects an array of strings called ids. What id's? Is it the string returned by addMarker?

The docs are very low effort (unfortunately not only on this plugin). Please add at least a short sentence that describes the purpose and workings of each function.

Expected Behavior

I can understand how to remove markers by reading the docs.

Code Reproduction

Reproduction: forget how the inner workings of this plugin are. Pretend that you've never used it before. Try to figure out how to remove markers by reading the docs.

Other Technical Details

I don't think that having Marker objects that do not have an id and the id strings separately is a bad idea because you need to keep a reference to both to have a full representation of a marker.

I would suggest to add the id to the Marker object to have one object with all the data needed to represent a marker.

Additional Context