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

doctrine-file

v2.0.1

Published

File-Reader for the Doctrine JSDoc Parser

Downloads

20,321

Readme

Doctrine-File

File-Reader for the Doctrine JSDoc Parser

Build Status codecov

Installation

You can install Doctrine-File using npm:

$ npm install doctrine-file --save-dev

Usage

Import doctrine-File inside of your JavaScript:

import { parseFile, parseFileContent } from 'doctrine-file';

parseFile(file[, options], callback)

  • file String PathName to a textfile
  • options Object
    • All options that doctrine.parse supports, except unwrap which can't be changed.
  • callback Function

The callback is passed two arguments (err, comments), where comments is an array of doctrine results. If no JSDocs can be extracted from the file, the array will be empty. When the file cannot be read err will contain the Error.

Here's a simple example:

parseFile('somefile.js', (err, comments) => {
  if (err) throw err;

  comments.forEach(console.log);
});

parseFileContent(content[, options])

  • content String | Buffer Content of a complete file to be parsed
  • options Object
    • All options that doctrine.parse supports, except unwrap which can't be changed.

Here's a simple example:

const content = fs.readFileSync('somefile.js', 'utf-8');

const comments = parseFileContent(content);

comments.forEach(console.log);

License

doctrine-file is licensed under the MIT license.