Discussion: How to document inferred types using TSDoc

I have a complex type that is inferred from yup schema, so something like:

export type Config =  y.InferType<typeof isConfig>

How would one ts-doc its properties manually?

[jayarjo]

It’s more about not having to update types in several places rather than elegance. Here’s the slice of type that is generated and exported to corresponding d.ts file:

declare const isConfig: y.ObjectSchema<{
    image: string;
    name: string;
    env: object;
    buildArgs: object;
    exposedPorts: any;
    networkMode: string;
    bindMount: any;
    startupTimeout: number;
    cmd: string;
    healthCheck: any;
    auth: any;
    useDefaultLogDriver: boolean;
}>;

[jayarjo]

@octogonz

1. that’s what doc parser can try to determine itself
2. how do you structure them for @param?