# jsdoc-typeof-plugin

> [![Build Status](https://travis-ci.org/cancerberoSgx/jsdoc-typeof-plugin.png?branch=master)](https://travis-ci.org/cancerberoSgx/jsdoc-typeof-plugin) [![Dependencies](https://david-dm.org/cancerberosgx/jsdoc-typeof-plugin.svg)](https://david-dm.org/cancer

Latest version **1.0.0** (published 2017-11-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install jsdoc-typeof-plugin
pnpm add jsdoc-typeof-plugin
yarn add jsdoc-typeof-plugin
bun add jsdoc-typeof-plugin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-07 |
| First published | 2017-11-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | cancerberosgx |

## Links

- npm: https://www.npmjs.com/package/jsdoc-typeof-plugin
- npm.io page: https://npm.io/package/jsdoc-typeof-plugin

## Recent versions

- 1.0.0 (latest) — 2017-11-07

## README

[![Build Status](https://travis-ci.org/cancerberoSgx/jsdoc-typeof-plugin.png?branch=master)](https://travis-ci.org/cancerberoSgx/jsdoc-typeof-plugin)
[![Dependencies](https://david-dm.org/cancerberosgx/jsdoc-typeof-plugin.svg)](https://david-dm.org/cancerberosgx/jsdoc-typeof-plugin)

# What

A jsdoc plugin that will convert types like `{typeof SomeClass}` into `{Class<SomeClass>}`

# Why

Because jsdoc3 doesn't support types which reference a class - just class instances. Also because we want to validate types using typescript jsdoc which supports the syntax `{typeof SomeClass}` to reference classes statically. Jsdoc currently fails generating documentation if it founds such expressions.

# How to use

```npm install jsdoc-typeof-plugin --save-dev```

Enable this plugin in your jsdoc configuration file:

```
    "plugins": ["node_modules/jsdoc-typeof-plugin"],
```

And now you are ready to use `{typeof SomeClass}`, for example:

```javascript
/**
* @return {typeof Something}
*/
static method1() {
    return null
}
```

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