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

Adding a document (missing example) #134

Closed
EskelCz opened this issue Jul 20, 2019 · 1 comment
Closed

Adding a document (missing example) #134

EskelCz opened this issue Jul 20, 2019 · 1 comment

Comments

@EskelCz
Copy link

EskelCz commented Jul 20, 2019

Maybe I'm missing something, but the readme is really missing a simple example on how to add a document in the correct data format. In issues here and at stack overflow, I've read multiple threads of people confused about this.

In documentation there is the GeoCollection.add method (which I assume is the best way to go about it) but the information on its data object structure is missing.
https://geofirestore.com/modules/_geofirestoretypes_.geofirestoretypes.html#documentdata

I have to dig way down into typescript definition to figure out it's just a wrapper for a GeoPoint: https://github.com/geofirestore/geofirestore-js/blob/aa80c71/src/GeoFirestoreTypes.ts#L13

So for something so basic to the function of this library, this feels inadequate.
Thanks for your consideration.

@MichaelSolati
Copy link
Owner

Noted, and thank you for the feedback. I'd say, if you wanted to open a PR and add it to the readme that would be awesome! (If not I'll try to get to it this week, I've been traveling a lot and just moved so it's been difficult)

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