DefinitelyTyped/DefinitelyTyped
DefinitelyTyped
DefinitelyTyped is a community-maintained type store and centralized JavaScript type registry. It serves as a repository of static TypeScript type declarations for third-party JavaScript libraries, providing the necessary metadata to enable compile-time safety and editor intelligence for external modules not originally written in TypeScript.
The project operates as a collaborative ecosystem where contributors define, validate, and maintain type declarations through a structured review process. This involves mapping type definition versions to specific library and compiler releases to ensure stability and synchronization across different environment versions.
The platform manages type accuracy through validation tools and test files to ensure declarations match actual runtime behavior. Its organizational structure supports scoped package naming conventions and dual-module declaration patterns that accommodate both global scripts and imported modules.
The repository includes processes for requesting missing definitions and removing redundant declarations when libraries begin bundling their own native types.
Features
- Type Definitions - Provides missing type definitions for third party modules to enable better editor autocomplete and compile time safety.
- TypeScript Type Definitions - Provides a community-driven repository of static TypeScript type declarations for third-party JavaScript libraries.
- Type Accuracy Validation - Uses dedicated test files and compiler checks to verify that declarations match actual runtime behavior.
- Type Metadata Registries - Serves as a centralized source of type metadata for third-party packages to improve editor intelligence.
- Type Definition Request Processes - Provides a structured community process for requesting missing type definitions through reported issues.
- Community Type Stores - Operates as a collaborative ecosystem where contributors define and validate TypeScript types for the JavaScript landscape.
- Ecosystem Type Maintenance - Collaboratively manages and reviews type declaration packages to ensure they match the runtime behavior of JavaScript libraries.
- Type Definitions - Provides custom type declarations for external JavaScript packages to enable compile-time safety and editor intelligence.
- Declaration Validation - Includes validation tools and test files to ensure type declarations match actual runtime behavior.
- Type Declaration Registries - A set of declaration files that provide type information for external modules not originally written in TypeScript.
- Contribution Workflows - Provides a structured process for creating, testing, and submitting new type declarations or augmenting existing ones.
- Contribution Workflows - Facilitates the creation and submission of new type declarations for community libraries through a structured review process.
- Library Ownership Management - Implements a system for assigning specific maintainers to oversee quality control for individual library type folders.
- Header-Based Constraints - Uses specific comments at the top of declaration files to define compatible compiler and library version ranges.
- Version and Compatibility Management - Maps type definition versions to specific library or compiler releases to ensure stability across environment versions.
- Compiler Version Mapping - Maps type definition versions to specific compiler releases to ensure stability across environments.
- Semantic Versioning Systems - Synchronizes type declaration versions with the major and minor versions of external libraries to maintain API consistency.
- Library Version Synchronization - Synchronizes type package versions with JavaScript library versions using semantic versioning in headers.
- Distribution Package Generators - Provides automated tools to transform repository directory structures into individual versioned packages for distribution.
- Dual-Module Declarations - Structures type files to support both global script loading and ES module imports within a single package.
- Dual-Module Declarations - Supports dual-module declaration patterns that accommodate both global scripts and imported modules.
- Package Scope Naming - Maps scoped npm packages to directory paths using a specific naming format to avoid folder collisions.
- Directory-to-Package Mappings - Organizes type definitions in a flat directory structure where folder names correspond to JavaScript library package names.
- Scoped Package Mapping - Implements scoped package naming conventions to maintain compatibility with package managers.
- Type Definition Generators - Provides tools to generate the directory structure and metadata files required for submitting new type definitions.
- Learning Resources - The central repository for community-maintained type definitions.
