search

faisalman / ua-parser-js

"Unmask Your Traffic" - UAParser.js: The Essential Web Development Tool for User-Agent Detection
https://uaparser.dev/
GNU Affero General Public License v3.0
9.28k stars 1.19k forks source link

Provide in-package type definitions #655

Closed lnhrdt closed 1 year ago

lnhrdt commented 1 year ago

@faisalman I noticed there's a few issues/PRs where this has been discussed before:

https://github.com/faisalman/ua-parser-js/issues/560 https://github.com/faisalman/ua-parser-js/pull/432 https://github.com/faisalman/ua-parser-js/issues/423 https://github.com/faisalman/ua-parser-js/pull/326 https://github.com/faisalman/ua-parser-js/pull/320

but would you consider supporting the types for your project directly in this repository?

@types/ua-parser-js hasn't been updated in over 2 years and the types are out of date with your upcoming 2.x release. Maybe you know what I'm talking about, I noticed even you have some // @ts-ignore suppressions in your tests. It might be easier to support the types in-package.

SUETAK commented 1 year ago

@types/ua-parser-js hasn't been updated in over 2 years and the types are out of date with your upcoming 2.x release. Maybe you know what I'm talking about, I noticed even you have some // @ts-ignore suppressions in your tests. It might be easier to support the types in-package.

I agree with this opinion. google is moving forward with their intention to UH and a full transition is in sight. I think the docs are misleading users because they recommend installing type/ua-parser-js but it is not really available.

faisalman commented 1 year ago

Maybe in the upcoming version I will also include the types.

I have modified the existing types in DefinitelyTyped, although not getting merged since v2.0 isn't released yet: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/66330