Socket
Socket
Sign inDemoInstall

doxy

Package Overview
Dependencies
3
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    doxy

Generic comment parser/serializer for css, and js


Version published
Weekly downloads
12
increased by9.09%
Maintainers
1
Install size
501 kB
Created
Weekly downloads
 

Readme

Source

doxy

Extracts single line // and multiline /* */ comments from a string or file. Has some added smarts for normalising indentation and aesthetic prefixing.

See the test fixture for the currently supported comment styles.

build status

example

var doxy = require('./lib/doxy');
console.log(doxy.parse(string));

methods

var doxy = require('./lib/doxy')

doxy.parse(string);

Returns an array of comments contained in the string.

doxy.fromFile(pathToFile);

Returns a promise that resolves to the result of doxy.parse(fileContents).

install

With npm do:

npm install doxy

license

MIT

FAQs

Last updated on 19 Jun 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc