mapbox / mapbox/mapbox-gl-js

Export more TS types

Open
#13,445 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

needs information :pray: types
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

## Motivation

Some types that are used are not exported. In this example we can use Offset and RGBAImage.

If we want use the same speification we now need to create our own type. The issue here is that if you change this in the future we will get a false positive that our typing is correct.

## Design Alternatives

Be more generous with exporting types.

## Design

NA

### Mock-Up

NA

### Concepts

NA

### Implementation

TS only since we just want to use your specifications

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Search the TypeScript public type declarations and existing exports for Offset and RGBAImage, then inspect how the package exposes its type surface. Done means the intended types are publicly consumable and remain aligned with the library specifications.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.