Skip to content

Document exported types in README #27563

@ddbeck

Description

@ddbeck

In the 5 August 2025 BCD meeting, we agreed that #27489 ought to ship. As part of that discussion, we agreed that there ought to be some sort of documentation covering that BCD exports TypeScript types and how to import them. This would demonstrate our commitment to treating TypeScript times as more than internal convenience (beyond the one line mentioning types in the SemVer policy).

I don't care strongly how types are documented, but my suggestion would be to append something to the code block demonstrating imports with something like:

// TypeScript types
import type { SimpleSupportStatement } from '@mdn/browser-compat-data';

Metadata

Metadata

Assignees

Labels

bugConfirmed bugs in the repository (i.e. linter bugs), NOT browser implementation bugs.docsIssues or pull requests regarding the documentation of this project.

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions