Typescript .d.ts

[Bigous]

Is it possible to you to deploy the definitions for Typescript for Highcharts within the npm package (like angular)?

[ry8806]

with the increasing popularity of TypeScript, I think this needs to happen. Many other js packages are starting to include their own (official) typings now. Rather than leave it up to the DefinitelyTyped community

[TorsteinHonsi]

This is something we are considering. It should be possible to make a node script to auto generate it from our API dump.

[hanssens]

+1 👍 from me as well. The DefinitelyTyped repo is outdated, where after Highcharts v4.2.x only sporadic and incidental properties were updated. But most of the changes in Highcarts are simply not processed.

So either the DefinitelyTyped repo should be updated or - more convenient - having it bundled with Highcharts would even be a much nicer solution.

Having it auto-generated sounds like a great option, but this might still require manual labor on the part of writing tests for the .d.ts file? Also, having it auto-generated might be.

I'd be willing to do some work in updating the DefinitelyTyped repo to the current release, and do a PR on https://github.com/highcharts/highcharts if you want to include the manual file there?

/cc @ry8806 @TorsteinHonsi

[hanssens]

^ I've created a PR for the DefinitelyTyped repo that implements Highcharts v5.0.10. If anyone is interested, this might be a good place to work further on (once and if it gets merged). At least for the time being, until the TypeScript definition file is deployed along with Highcharts itself.

[jonrh]

Having official TypeScript type definitions would be highly appreciated. Helps a lot when typing out a chart config.

[aaronbeall]

Here we are again with the type definitions a major version behind reality. :/

Given the complexity of this library I think the best solution is to generate the type-defs from the "API dump" that @TorsteinHonsi referred to. However that link appears to be broken. Is there a new one? I would be willing to take a stab at writing a generator.

[TorsteinHonsi]

However that link appears to be broken. Is there a new one?

Yes, the new one is available from https://api.highcharts.com/highcharts/tree.json. This tree is generated from our JSDoc comments and parsed source code.

@cvasseng FYI.

[aaronbeall]

@TorsteinHonsi Thanks I'll take a look at this. Are you using a particular flavor of "jsdoc" (Google Closure, JSDoc 3?) Does the JSON dump happen somewhere in this code-base I can look at for reference? The reason I ask is because there are existing JSDoc-to-TSDef convertors out there which might work...

[TorsteinHonsi]

We are using JSDoc 3, but heavily extended to be able to describe our declarative options structure.

[aaronbeall]

@TorsteinHonsi Looking at the JSON I have a few questions... you don't by any chance have a schema documentation on this format? This is what I've collected. How do you designate options that are passed to Highcharts.setOptions() vs Highcharts.chart() (for example)? Is there an API dump for the classes and namespaces as well?

[KacperMadej]

@cvasseng

[cvasseng]

Hi @aaronbeall, we don't have any thorough documentation on the schema at this time, but it looks like you got it all in your definition.

The options for Highcharts.setOptions(), and the series are both handled as special cases outside of the schema itself where we use it, but we should change at least global and lang to be outside of the main options structure.

As a side note, the old dump format was available at https://api.highcharts.com/dump.json, we've now moved it back to the original position at https://api.highcharts.com/highcharts/option/dump.json.