# typedoc-plugin-resolve-by-name

> Fall back to name-based type resolution

Latest version **0.1.0** (published 2020-06-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-plugin-resolve-by-name
pnpm add typedoc-plugin-resolve-by-name
yarn add typedoc-plugin-resolve-by-name
bun add typedoc-plugin-resolve-by-name
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-06-30 |
| First published | 2020-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam Jarret |
| Maintainers | atj |
| Keywords | typedocplugin, typedoc |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-resolve-by-name
- Repository: https://github.com/adamjarret/typedoc-plugin-resolve-by-name
- Homepage: https://github.com/adamjarret/typedoc-plugin-resolve-by-name#readme
- Issues: https://github.com/adamjarret/typedoc-plugin-resolve-by-name/issues
- npm.io page: https://npm.io/package/typedoc-plugin-resolve-by-name

## Recent versions

- 0.1.0 (latest) — 2020-06-30

## README

# typedoc-plugin-resolve-by-name

[![npm version](https://img.shields.io/npm/v/typedoc-plugin-resolve-by-name.svg?style=flat)](https://npmjs.org/package/typedoc-plugin-resolve-by-name 'View this project on npm')
[![git repository](https://img.shields.io/badge/source-GitHub-blue)](https://github.com/adamjarret/typedoc-plugin-resolve-by-name 'View this project on GitHub')

A plugin for [TypeDoc](http://typedoc.org) that enables unresolved type reflections to be resolved using only their name (as opposed to their fully qualified identifier).

Caution: If all exported `type`/`interface`/`function`/`class`/etc names are not unique
within your project, results may be unpredictable.

## Installation

```bash
npm i -D typedoc-plugin-resolve-by-name typedoc
# yarn add -D typedoc-plugin-resolve-by-name typedoc
```

## Usage

TypeDoc automatically loads all installed plugins, so just run the `typedoc` command:

```bash
npx typedoc
# yarn typedoc
```

## Example

Example **typedoc.js** file (in project root):

```js
module.exports = {
  name: 'PROJECT NAME',
  mode: 'modules',
  out: 'docs',
  exclude: [
    // exclude index.ts files to ignore re-exports
    '**/index.ts',
    // exclude node_modules directories
    '**/node_modules/**',
    // exclude built output from tsc
    '**/packages/**/lib/**',
    // exclude files in __tests__ directories
    '**/__tests__/**',
    // exclude unit tests
    '**/*.test.ts'
  ],
  excludePrivate: true,
  excludeProtected: true,
  excludeExternals: true,
  excludeNotExported: true
};
```

## License

[MIT](https://github.com/adamjarret/typedoc-plugin-resolve-by-name/tree/master/LICENSE)

## Author

[Adam Jarret](https://atj.me)

---
_Source: https://npm.io/package/typedoc-plugin-resolve-by-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._