# @component-controls/react-docgen-typescript-info

> Component controls react-docgen-typescript props info loader

Latest version **4.0.3** (published 2022-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @component-controls/react-docgen-typescript-info
pnpm add @component-controls/react-docgen-typescript-info
yarn add @component-controls/react-docgen-typescript-info
bun add @component-controls/react-docgen-typescript-info
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2022-01-14 |
| First published | 2020-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 48.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 82 |
| Maintainers | atanasster |

## Links

- npm: https://www.npmjs.com/package/@component-controls/react-docgen-typescript-info
- Repository: https://github.com/ccontrols/component-controls
- Issues: https://github.com/ccontrols/component-controls/issues
- npm.io page: https://npm.io/package/@component-controls/react-docgen-typescript-info

## Dependencies (2)

- [react-docgen-typescript](https://npm.io/package/react-docgen-typescript.md) ^2.0.0
- [@component-controls/core](https://npm.io/package/@component-controls/core.md) ^4.0.3

## Recent versions

- 4.0.3 (latest) — 2022-01-14
- 3.14.6 — 2021-05-20
- 3.14.5 — 2021-05-19
- 3.14.2 — 2021-05-18
- 3.14.0 — 2021-05-17
- 3.13.0 — 2021-05-17
- 3.12.0 — 2021-05-13
- 3.11.4 — 2021-05-11
- 3.11.0 — 2021-05-10
- 3.10.3 — 2021-05-09
- 3.10.2 — 2021-05-09
- 3.10.0 — 2021-05-08
- 3.9.0 — 2021-04-30
- 3.8.2 — 2021-04-30
- 3.8.0 — 2021-04-29
- … 101 more at https://npm.io/package/@component-controls/react-docgen-typescript-info/versions

## README

# Table of contents

-   [Overview](#overview)
-   [Installation](#installation)
-   [API](#api)
    -   [run](#run)

# Overview

Extract props info from react typescript components:

-   Uses [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript)

# Installation

This package is usually installed as part of the @component-controls package, but you can also install it standalone to extract props info from react typescript components

```bash
$ npm install @component-controls/react-docgen-typescript-info --save-dev
```

# API

<api-readme />

<!-- START-API-README -->

## run

**`function`**

run API to generate react-docgen-typescript props information tables.

_defined in [@component-controls/react-docgen-typescript-info/props-info/react-docgen-typescript/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/props-info/react-docgen-typescript/src/index.ts#L14)_

**parameters**

| Name      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Description                                            |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `options` | <details><summary>`type`</summary><blockquote>`transformProps`: **function** (<br />`props`\*: `ComponentDoc`\[]<br />) => <details><summary>`ComponentDoc`</summary><blockquote>`expression`: ts.Symbol<br />`displayName`\*: `string`<br />`filePath`\*: `string`<br />`description`\*: `string`<br /><details><summary>`props`\*</summary><blockquote>\[`string`]: `T`</blockquote></details>`methods`\*: `Method`\[]<br /><details><summary>`tags`</summary><blockquote>\[`string`]: `T`</blockquote></details></blockquote></details><br />`propFilter`: `StaticPropFilter` \| `PropFilter`<br />`componentNameResolver`: **function** (<br />`exp`\*: Symbol<br />`source`\*: SourceFile<br />) => `string` \| `undefined` \| `null` \| `false`<br />`shouldExtractLiteralValuesFromEnum`: `boolean`<br />`shouldRemoveUndefinedFromOptional`: `boolean`<br />`shouldExtractValuesFromUnion`: `boolean`<br />`skipChildrenPropWithoutDoc`: `boolean`<br />`savePropValueAsString`: `boolean`<br />`shouldIncludePropTagMap`: `boolean`<br />`shouldIncludeExpression`: `boolean`<br />`customComponentTypes`: `string`\[]</blockquote></details> | configuration options                                  |
| `returns` | PropsInfoExtractorFunction                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | a callable function of type PropsInfoExtractorFunction |

<!-- END-API-README -->

---
_Source: https://npm.io/package/@component-controls/react-docgen-typescript-info · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._