You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

typedoc-plugin-expand-object-like-types

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typedoc-plugin-expand-object-like-types

Expands TS definitions of object-like types

0.1.2
latest
Source
npmnpm
Version published
Maintainers
1
Created
Source

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.

Keywords

typedoc-plugin

FAQs

Package last updated on 14 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts