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

word-counts

v0.1.9

Published

Count all the words in a given string or file.

Downloads

6

Readme

word-counts

Count all the words in a given string or file and return an object containing word count data.

Installation

Install the package from npm

npm install word-counts

Usage

Provide a string or local filepath containing text which can be scanned in order to populate the word frequency table.

const { countWords } = require("word-counts");

const doc = `Hello, World. This is some example text that 
repeats the word test. Usually a test covers multiple topics
but the real test is to learn something by the end of a test.`;

const wordTable = countWords(doc);
console.log(wordTable);
console.log(wordTable.wordCount);
console.log(wordTable.uniqueWordCount);

/*
{
  a: { frequency: 2, usage: 6.5 },
  by: { frequency: 1, usage: 3.2 },
  covers: { frequency: 1, usage: 3.2 },
  ...
}
32
25
*/

Scan a file:

countWordsInFile("words.md").then(data => {
  console.log(data);
});

Methods

  • countWords(doc): Count the frequency of words in a given string.
  • countWordsInFile(file, encoding="utf8"): Count the frequency of words in a local file.

Attributes

The countWords and countWordsInFile functions both return WordMap objects which contain the following fields:

  • frequencies: Object representing the word frequency table.
  • wordList: A list of all the words.
  • uniqueWordList: A list of all the unique words.
  • sortedUniqueWordList: A sorted list of all the unique words.
  • sortedFrequencyList: A sorted list of word frequency objects.
  • wordCount: Count of all words.
  • uniqueWordCount: Count of all unique words.
  • printFrequencies(): Get a stringified version of the word frequency table.
  • getNthWord(n): Get the Nth word from the word list.

Tests

Install dev dependencies:

npm install -d

and run test suite:

npm run test

Contributing

If you find any bugs or would like to suggest a feature, feel free to create an issue.