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

jsdoc3-plugin-propertyof

v0.0.1

Published

A jsdoc plugin that allow you documenting complex types and json files

Downloads

130

Readme

jsdoc3-plugin-memberof

This plugin allows you to split split the documentation of large objects into several documentation blocks.

Lets consider an example:

/**
 * The complete Triforce, or one or more components of the Triforce.
 * @typedef {Object} Triforce
 * @property {boolean} [hasCourage=false] - Indicates whether the Courage component is present.
 * @property {boolean} [hasPower=false] - Indicates whether the Power component is present.
 * @property {boolean} [hasWisdom=false] - Indicates whether the Wisdom component is present.
 */

You can now document it like this:

/**
 * @typedef {Object} Triforce The complete Triforce, or one or more components of the Triforce.
 */
{
	/**
	 * Indicates whether the Courage component is present.
	 * @type boolean
	 * @default false
	 * @propertyof Triforce
	 */
	 hasCourage: false,
	
	/**
	 * Indicates whether the Power component is present.
	 * @type boolean
	 * @default false
	 * @propertyof Triforce
	 */
	hasPower: false,
	
	/**
	 * Indicates whether the Wisdom component is present.
	 * @type boolean
	 * @default false
	 * @propertyof Triforce
	 */
	hasWisdom: false
}