TypeScript declarations

[cmoog]

Loving this new API 👍, great work all around.

TypeScript declaration files would be a solid UX improvement, making the API surface even more approachable for new comers.

[Fil]

I've never done this but a pull-request, even if it's incomplete, would help to get us started.

In particular I don't know how to test the coverage of ts declarations in CI.

A good starting point is probably the README.md API docs, which is the reference (source of truth).

[clhenrick]

Because Plot uses D3 under the hood, I believe this would be preceded by having up to date and well maintained TS declarations for D3. Currently the Definitely Typed package has some pain points that I've run into when using TypeScript with D3, which I imagine would affect the TS declarations for Plot.

[kentr]

Because Plot uses D3 under the hood, I believe this would be preceded by having up to date and well maintained TS declarations for D3. Currently the Definitely Typed package has some pain points that I've run into when using TypeScript with D3, which I imagine would affect the TS declarations for Plot.

@Fil @clhenrick I've been experimenting with type declarations for Plot, so I'd like to know if any of the pain points that you referred to have been resolved with the recent work on the D3 types.

I'm referring to these updates:

• [@types/d3] Please update types to last version of d3 DefinitelyTyped/DefinitelyTyped#38939
• [d3] Update to v7.1 DefinitelyTyped/DefinitelyTyped#56119
• [d3] Update dependency packages to latest major (part 1) DefinitelyTyped/DefinitelyTyped#54021
• [d3] Update dependency packages to latest major (part 2) DefinitelyTyped/DefinitelyTyped#54044
• [d3] Update dependency packages to latest major (part 3) DefinitelyTyped/DefinitelyTyped#54101

[Fil]

Thank you for the work you are doing on d3 types! I'd be happy to see your experiments with Plot.

[kentr]

@Fil Ah, I mixed up my previous reply. I thought that the comment I quoted was from you, but now I see that it was not.

Those D3 updates are the work of some other wonderful people. I can't claim any credit for them. I'll create a PR for the Plot type experiments. They are very new, so it will be more of a starting point as you suggested than an actual request to merge.

[sgehrman]

Does Plot work with typescript or not? I'm getting errors.

[dgrcode]

@sgehrman It does work with typescript, although there are no type declarations (as far as I know).

If you want to remove the type errors, what I've done to get it working is to create a file in your project declaring the types. For me that looks like the following:

// file /types/untypedDependencies.d.ts
declare module '@observablehq/plot'

It would be great to have types to get code completion and better linting though :)

[kentr]

If you want to remove the type errors, what I've done to get it working is to create a file in your project declaring the types.

Same for me.

It would be great to have types to get code completion and better linting though :)

The project has started converting files to TypeScript, but it looks like those files aren't in a release yet.

Edit: I was wrong. There are some TS files in a release.

[mbostock]

Fixed in #1320! And more documentation to follow immediately.

[mbostock]

Released in 0.6.5.

[cmoog]

Wow, I just tried these out and they are incredible! The types, documentation, everything!