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

metadata-ts-loader

v1.2.0

Published

Webpack loader to parse typescript metadata from source code.

Downloads

2

Readme

metadata-ts-loader

A Webpack loader for extracting typescript metadata (interface, comments jsDoclets, etc) defined in TypeScript. Helpful for get documentation information from typescript, it parse and return JSON metadata when requiring a file.

Installation

$ npm install --save metadata-ts-loader

Usage

Generally you will want to use the inline request syntax for using this loader, instead of adding it to your config file.

var metadata = require('metadata-ts-loader!./some/my-component');

metadata.metadataDocs[0] // { props, description, displayName }

If you want to get an object mapped with displayName instead of array, you can set mapping=true as bellow

var metadata = require('metadata-ts-loader?mapping=true!./some/my-component');

metadata // { [displayName]: { props, description, displayName } }

Instruction

The loader will parse out any jsDoc style from typescript comment blocks. You can access them from metadata.metadataDocs[0].props

  • @default: for manually specifying a default value for a prop.

Exporting

It is important to export your module using a named export for docgen information to be generated properly.


interface.ts:

/**
 * Button properties.
 */
// Notice the named export here, this is required for docgen information
// to be generated correctly.
export interface IButtonProps {
  /**
   * Value to display, either empty (" ") or "X" / "O".
   *
   * @default " "
   **/
  value?: " " | "X" | "O";

  /** Cell position on game board. */
  position: { x: number, y: number };

  /** Called when an empty cell is clicked. */
  onClick?: (x: number, y: number) => void;
}

Will generate the following outpout:

{
  "metadataDocs": [{
    "description": "Button properties.",
    "displayName": "IButtonProps",
    "methods": [],
    "props": {
      "value": {
        "defaultValue": {
          "value": "\" \""
        },
        "description": "Value to display, either empty (\" \") or \"X\" / \"O\".",
        "name": "value",
        "required": false,
        "type": {
          "name": "\" \" | \"X\" | \"O\""
        }
      },
      "position": {
        "defaultValue": null,
        "description": "Cell position on game board.",
        "name": "position",
        "required": true,
        "type": {
          "name": "{ x: number; y: number; }"
        }
      },
      "onClick": {
        "defaultValue": null,
        "description": "Called when an empty cell is clicked.",
        "name": "onClick",
        "required": false,
        "type": {
          "name": "(x: number, y: number) => void"
        }
      }
    }
  }]
}

Export Names

Typescript docgen information can not be generated for module that are only exported as default. You can work around the issue by exporting the module using a named export.

/**
 * TicTacToe game cell. Displays a modal when the visible is true,
 * otherwise hide.
 */
// Notice the named export here, this is required for docgen information
// to be generated correctly.
export class TicTacToeCell {
  /** modal visibility */
  visible = false;

  /** Click to change visibility */
  handleClick = () => {
      this.visible = !this.visible;
  };
}

// TicTacToeCell can still be exported as default.
export default TicTacToeCell;

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.