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

tsdgen

v0.2.0

Published

A .d.ts generator for Node.js from other .d.ts files. Creates a module definition for all the classes exported via @inmodule JsDoc annotation.

Downloads

5

Readme

tsdgen

Parses multiple .d.ts definition files and outputs node ready definitions.

Usage

Use A JsDoc annotation that specifies in what module the interface or class is exported.

/**
 * Class that does this and that.
 * @inmodule "best-module-of-all-times"
 */
export class BestClass {
   // ...
}

Compile this file (or all the files that export classes) with -d in tsc, then post process the .d.ts files in order to get the final module .d.ts. For example in terminal-console the TerminalConsole class has the @inmodule annotation:

/**
 * A class that allows relogging the previously written message by using the
 * ANSI up code.
 * @inmodule "terminal-console"
 */
export class TerminalConsole {

When processing all the generated .d.ts files from the lib/ file, the terminal-console.d.ts will contain only this exported class, in the right module. Multiple modules could be specified for the same class, using multiple @inmodule annotations. In order to run this automatically, including the watching of *.ts files, fast-live-reload ties things together:

fast-live-reload -o\
    -ep "bash -c 'tsc -w src/main/core/*.ts --outDir lib/ -d --module commonjs'"\
    lib/ -e "bash -c 'tsdgen -o terminal-console.d.ts lib/*.d.ts'"

As available in the live-reload.sh script. The tsc compiler will compile the sources into the lib folder, and after the tsdgen will generate the module .d.ts file.

Grunt

If you want to use tsdgen with grunt, you can just npm install it with --save-dev and then edit your Gruntfile.js configuration:

module.exports = function(grunt) {
    // configuration for the plugins.
    grunt.initConfig({
        // ...
        tsdgen : {
            "dist" : {
                files : [
                    {
                        src: [
                            "lib/core-promise.d.ts"
                        ],
                        dest: "./core-promise.d.ts"
                    }
                ]
            }
        }
    });
    // load NPM tasks:
    grunt.loadNpmTasks("tsdgen");
    // register our tasks:
    grunt.registerTask("default", ["tsdgen"]);
};

Multiple .d.ts files can be passed for input, in order to output a single module definitions file.

ChangeLog

v0.2.0 2015-07-21 Added a grunt task to generate definitions. v0.1.1 2015-07-10 Bugfix Parse local definitions. Parse only files sent via nomnom.