mapbox / mapbox/mapbox-gl-directions

Missing TypeScript type definitions for mapbox-gl-directions package

Open
#300 1 comment 11 reactions 0 assignees View on GitHub
auto-triaged enhancement
Dominant language
JavaScript
Stars
255
Forks
130
PR merge metrics
No merged PRs in 30d

Description

### Issue Description
I'm trying to use mapbox-gl-directions on my React TypeScript project, and I want to install type definitions for it using yarn add @types/mapbox__mapbox-gl-directions. However, I found that there aren't any type definitions available for this package.

### Expected Behavior
I expected to be able to install type definitions for mapbox-gl-directions using yarn add @types/mapbox__mapbox-gl-directions.

Actual Behavior
When I tried to install the type definitions using the above command, I got the following error:

```
An unexpected error occurred: "https://registry.yarnpkg.com/@types%2fmapbox__mapbox-gl-directions: Not found".
```

### Steps to Reproduce
Create a new React TypeScript project
Install mapbox-gl-directions using yarn add mapbox-gl-directions
Try to install type definitions using yarn add @types/mapbox__mapbox-gl-directions

### Possible Solution
I'm not sure if there's a solution to this issue, but it would be great if someone could create and publish type definitions for mapbox-gl-directions to @types/mapbox__mapbox-gl-directions registry.

Please let me know if there's anything else I can provide to help resolve this issue.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the mapbox-gl-directions package API and its published JavaScript surface. Check the TypeScript declaration conventions used for @types packages, then verify the definitions against a React TypeScript project using the installation command from the issue. Done means usable definitions are available as @types/mapbox__mapbox-gl-directions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.