typedoc-plugin-expand-object-like-types
v0.1.2
Published
Expands TS definitions of object-like types
Downloads
4,454
Readme
Expands TS definitions for object-like types
A Typedoc plugin that expands TS definitions for object-like types.
Take the following example.
export type A = { name: string; email: string };
export type B = { age: number };
export type C = Omit<A, 'email'> & Partial<B> & { id: number };
With this plugin, type C
will expand to the following definition in your docs.
export type C = {
name: string;
age?: number;
id: number;
};
Installation
npm install typedoc-plugin-expand-object-like-types -D
Typedoc will automatically detect this plugin once installed.