Typings

[hennessyevan]

Would it be possible to get some typescript typings for this package, either in the repo or on definitely typed?

[sherwinski]

Hey @hennessyevan, we've been getting more requests for this (and our other JS projects) lately, so it's definitely something we're planning to look into in the near future. I don't have an exact timeline at the moment but I'll be sure to update you when we get to it.

[gatherben]

+1 on typings!

[guanzo]

There should be typings for the param argument to buildURL.

I'm sorry but this is just lazy params?: {}.

The set of valid values are finite and well defined, there should be explicit types.

This is what your typings should look like. https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-imgix/index.d.ts

[sherwinski]

Hey @guanzo,

I agree that params deserves better typings. As a team, we are planning to pull in imgix-url-params as a dependency from which these definitions can be robustly constructed. This will help account for changes to the rendering API, as well as any new parameters that get added. To that end, params was assigned a very rudimentary type just to start out, but we expect to start work on pulling in these definitions in the near future. Hope that helps.

[guanzo]

Ok great, thanks for clarifying. Sorry I called you guys lazy!

[ericdeansanchez]

🎉 This issue has been resolved in version 0.3.0-beta.1 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[robinjonsson]

The typings for buildURL is still missing.
https://github.com/imgix/js-core/blob/v3.3.0-beta.1/src/index.mjs#L43

[sherwinski]

Hey @robinjonsson, the typings should be included in the project's index.d.ts file.

[robinjonsson]

Hi @sherwinski, I meant that the params argument is still pointing to an empty object. It would be great if params had the correct types.

[sherwinski]

Ah sorry about that, I misunderstood your first comment. Apologies for the delays on this feature, but we have finally set aside time to build this out later this year.