npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tsd-jsdoc

v2.5.0

Published

Compiles JSDoc annotated javascript into a Typescript Declaration File (.d.ts).

Downloads

21,649

Readme

tsd-jsdoc

This library's goal is to be able to take as input a JSDoc annotated source JavaScript file (or many files) and output a single TypeScript Declaration File (.d.ts).

It is distributed as a JSDoc3 template. Running JSDoc with this as the template should result in a TypeScript Definition File.

Installation

You can install this module from npm:

$> npm install tsd-jsdoc

Usage

To use this module, simply specify it as the template for your normal JSDoc generation.

For example, from the command-line you can do:

$> jsdoc -t node_modules/tsd-jsdoc/dist -r .

Or add this to your JSON configuration:

{
    "opts": {
        "template": "./node_modules/tsd-jsdoc/dist"
    }
}

If you want to use jsdoc/closure tag @template, you also need to specify this module as a plugin, like so:

{
    "plugins": [ "./node_modules/tsd-jsdoc/dist/plugin" ],
    "opts": {
        "template": "./node_modules/tsd-jsdoc/dist"
    }
}

Validation

This library provides very little validation beyond what JSDoc provides. Meaning if you have invalid JSDoc comments, this will likely output an invalid TypeScript Definition File.

Additionally there are things that JSDoc allows, that TypeScript does not. This library tries to make these differences transparent, and translate from one to the other when necessary. It can't handle anything though, and you can generate invalid Typescript even if your JSDoc is valid.

Unsupported Features

Default exports

JSDoc has a bug that prevents it from correctly parsing export default class Name {}. The workaround is to use named exports (export class Name {}) or utilize the jsdoc-export-default-interop plugin.

Tags with no support

Tags that describe the code, but support is not implemented are:

Ignored tags

Tags that are just metadata and don't actually describe the code are ignored. These are:

All other JSDoc tags should work fine.

Supported ClosureCompiler Tags

ClosureCompiler has a couple tags beyond the built-in JSDoc tags that can improve your TypeScript output. Here is a complete list of the tags from CC that are supported in this template:

Extended support for TS features

JSDoc doesn't have a way to express all the features of typescript so we treat some syntax as special case to create better Typescript.

  • Class<T> - If we encounter a type that is Class<T> we will treat it as typeof T. See jsdoc3/jsdoc#1349