Summary
Currently, TypeScript users of basic-auth rely on the external @types/basic-auth package for type definitions. To improve maintainability, developer experience, and ensure type definitions stay in sync with the library, this proposal suggests migrating the type definitions directly into the basic-auth package.
Benefits
- Improved Maintainability: Type definitions will be updated alongside the core library, reducing the risk of outdated or mismatched types.
- Better Developer Experience: Users won’t need to install an additional
@types/basic-auth package.
- Increased Adoption: Built-in types may encourage more developers to use the library with TypeScript.
Proposed Changes
- Add a
index.d.ts file with the current type definitions from @types/basic-auth.
- Update
package.json to include "types": "index.d.ts".
- Ensure types align with the latest API and are well-documented.
- Remove the need for
@types/basic-auth and update documentation accordingly.
- Deprecate
@types/basic-auth
Summary
Currently, TypeScript users of
basic-authrely on the external@types/basic-authpackage for type definitions. To improve maintainability, developer experience, and ensure type definitions stay in sync with the library, this proposal suggests migrating the type definitions directly into thebasic-authpackage.Benefits
@types/basic-authpackage.Proposed Changes
index.d.tsfile with the current type definitions from@types/basic-auth.package.jsonto include"types": "index.d.ts".@types/basic-authand update documentation accordingly.@types/basic-auth