fix(common): make DirectionsStep.steps an optional DirectionsStep[] - #1423
Draft
simonyang08 wants to merge 2 commits into
Draft
fix(common): make DirectionsStep.steps an optional DirectionsStep[]#1423simonyang08 wants to merge 2 commits into
simonyang08 wants to merge 2 commits into
Conversation
The previous typings declared `steps: DirectionsStep` and `transit_details: TransitDetails` on `DirectionsStep`, which did not match the Google Directions API response: * Substeps (`steps`) are returned as an array and only for transit travel mode; non-transit steps omit the field entirely. * `transit_details` is only returned for transit travel mode. Mark both fields optional and type `steps` as `DirectionsStep[]`. Fixes googlemaps#1319 Signed-off-by: simonyang08 <ppt5928@gmail.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Signed-off-by: simonyang08 <ppt5928@gmail.com>
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
2 participants
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.
Fixes #1319
The
DirectionsStepinterface insrc/common.tspreviously declaredstepsandtransit_detailsas required non-optional fields, and declaredstepsas a singleDirectionsSteprather than an array.This does not match the Google Directions API response:
steps[i].stepsis only populated fortravel_mode === "transit"and is always returned as an array (see API docs: "If the directions include multiple modes of transportation, detailed directions will be provided for walking or driving steps in an innerstepsarray").steps[i].transit_detailsis only returned fortravel_mode === "transit".This change:
stepsas the optionalDirectionsStep[].transit_detailsoptional as well.Both changes were requested in #1319 and the prior (now-closed) attempt at PR #1389.
Added regression test:
src/common.directionsstep.test.ts(compile-time type assertions + runtime sanity checks), including a pinnedTransitDetails-typed transit step. All 72 unit tests pass with the fix; the new test fails to compile against the previous typings.Local checks:
npm run build(tsc): clean.npx jest --runInBand ./src/: 72/72 pass.bash test-module-loading.sh: cjs + esm loads succeed.CLA: I will sign the Google Individual CLA when a maintainer approves.
Signed-off-by: simonyang08 ppt5928@gmail.com