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.