Joe/add directions api #213
Open
Conversation
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
kochis
reviewed
Aug 6, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new directions API to the Web SDK, providing route guidance functionality with step-by-step instructions. The implementation includes comprehensive type definitions for maneuvers and directions data structures, along with proper API integration.
Key changes:
- Added directions API endpoint with support for locations, travel mode, units, avoid options, and geometry
- Introduced comprehensive type definitions for directions responses including legs, steps, and maneuver types
- Added test coverage for the new directions functionality
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/types.ts | Defines RadarDirectionsParams, response interfaces, and maneuver types for the directions API |
| src/api/routing.ts | Implements the directions method with parameter processing and HTTP request handling |
| src/api.ts | Exposes the directions API as a public method on the main Radar class |
| test/api/routing.test.ts | Adds test coverage for the directions API functionality |
jaspk06
reviewed
Aug 7, 2025
jaspk06
reviewed
Aug 7, 2025
Also reran tests with new types.
| geometry, | ||
| } = params; | ||
|
|
||
| if( Array.isArray(locations) ) { |
There was a problem hiding this comment.
Nit fix spacing ie
if (Array.isArray(locations)) {
| }); | ||
|
|
||
| describe( 'getDirections', () =>{ | ||
| describe( 'all args given', () => { |
| import Radar from '../../src'; | ||
| import Config from '../../src/config'; | ||
| import { RadarOptions, RadarTravelMode } from '../../src/types'; | ||
| import {Location, RadarOptions, RadarTravelMode} from '../../src/types'; |
There was a problem hiding this comment.
Nit fix spacing ie
import { Location, RadarOptions, RadarTravelMode } from '../../src/types';
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.
Added the directions API to the Web SDK.
Added a test and ran succesfully. Also showed the API working with all inputs in the console on the demo.
Reran tests w/ updated type descriptions:
