Documentation for io-ts types

[singharpit94]

Hi,
I am using io-ts for defining my types and use them for run time validations. I would like to generate documentation for my types which can help users to know about the types and shape of interface.

For example for an interface like this

const someInterface = t.exact(t.interface({
    /**
     * Id of interface
     */
    id: t.string,
    /**
     * name of some property
     */
    name: t.string,
    /**
     * renderer for some component
     */
    customRenderer: ReactElement,
    /**
     * some custom type example
     */
    someProperty: customType,

}));

I want to generate documentation which contains the comments for the property to be used as their description and also the types associated with them.

Is there any support for generating the documentation for these types of interfaces.

[mmkal]

this works for me already in vscode:

[gcanti]

@mmkal I didn't know that, looks like mapped types preserve JSDoc comments

declare function f<O>(o: O): { [K in keyof O]: null }

const x = f({
  /** name documentation */
  name: 'foo'
})

x.name // <= hover on `name`