typedoc-plugin-expand-object-like-types

0.1.2 • Public • Published

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.

Readme

Keywords

Package Sidebar

Install

npm i typedoc-plugin-expand-object-like-types

Weekly Downloads

1,273

Version

0.1.2

License

MIT

Unpacked Size

7.85 kB

Total Files

4

Last publish

Collaborators

  • lorisleiva