fix(types): type geo_distance_meters as a field-name map - #367
Open
cpruijsen wants to merge 1 commit into
Open
Conversation
Hits key this object by the collection geopoint field, not a hardcoded `location`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SearchResponseHit.geo_distance_metersis now{ [key: string]: number }, keyed by the collection's geopoint field.Fixes #348.
{ location: number }matched the geosearch docs example only because that collection's field is namedlocation. Acoordinatesgeopoint returns{ "coordinates": 95432 }and did not type-check.Decision
{ [key: string]: number }{ [TAttribute in keyof T]?: number }(same pattern asSearchResponseHighlight)Client.collections()defaultsTtoobject, andkeyof objectisnever, so a mapped type would make.locationa type error on the untyped path the docs use. The issue asked for a string index signature first.Test plan
pnpm typecheckfails without the source change and passes with it (test/geo_distance_meters.type.test.ts)coordinatestype-checks on a document that declares that fieldcoordinatesandlocationtype-check on the default document generic (object)