-
-
Notifications
You must be signed in to change notification settings - Fork 89
Open
Labels
Description
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
tobz1000