@zakkudo/jsdoc-native-plugin

Adds custom types to jsdoc to help document native features from html and javscript

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Aug 8, 2018Aug 5, 2018Minified + gzip package size for @zakkudo/jsdoc-native-plugin in KB

Readme

jsdoc-native-plugin

Adds tags to help document native functionality of javscript/html without having to copy-paste text around.

Install with:

yarn add --dev @zakkudo/jsdoc-native-plugin

Add to your jsdoc config with:

    "plugins": [
        "@zakkudo/jsdoc-native-plugin"
    ],

Includes typedefs for

  • Native namespace
  • Native.DocumentFragment
  • Native.CustomEvent
  • Native.Promise
  • ...this will likely grow in the future. Pull requests welcome!

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.