ts-json-schema-generator icon indicating copy to clipboard operation
ts-json-schema-generator copied to clipboard

Better jsDoc Support for Partials/Records

Open hypery2k opened this issue 3 years ago • 0 comments

Is it somehow possible to support partials via jsdoc comments, e.g.:

export  type Dynamic =
...
;

export type DynamicFieldAreaKey =
  | 'registration'
  | 'guest';
  /**
   * Configure dynamic optional fields
   * @property registration - Optional fields for registration (e.g., checkbox for newsletter signup)
   * @property guest - Optional fields for guest (e.g., checkbox for newsletter signup)
   */
  dynamicFields?: Partial<Record<DynamicFieldAreaKey, DynamicOptions>>;

Or did we need to use a customer formatter for that?

Any suggestion would be appreciated.

hypery2k avatar Jun 14 '22 06:06 hypery2k