Typedoc: Type definitions for JSON serialization

Created on 10 Jun 2018  路  6Comments  路  Source: TypeStrong/typedoc

Hi,

I'm trying to use the documentation in JSON format to generate my documentation. I'm looking for the type definitions to type the imported JSON file. Where can I find them ?

Thank you !

Most helpful comment

I wrote my own types for it, they aren't complete but perhaps a useful starting point: https://github.com/0xProject/0x-monorepo/blob/development/packages/react-docs/src/types.ts#L57

All 6 comments

Unfortunately, there isn't a type definition at the moment. I'd suggest looking at the spec files for examples.

Hi
What do you mean by spec file? Where can I find some?
Thank you

See the src/test/converter/_____/spec.json files in this repo

I wrote my own types for it, they aren't complete but perhaps a useful starting point: https://github.com/0xProject/0x-monorepo/blob/development/packages/react-docs/src/types.ts#L57

Great ! Would it be possible to put those definitions into Typedoc itself, so users could import those types from the Typedoc node module?

Cheers !

Closing in favor of #605, I'm working on a change that would integrate types for the JSON output & should close that issue as well.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mirismaili picture mirismaili  路  3Comments

euberdeveloper picture euberdeveloper  路  3Comments

0815fox picture 0815fox  路  3Comments

nidsharm picture nidsharm  路  3Comments

goodmind picture goodmind  路  3Comments