README

Word Counter

JavaScript word counter.

Demo

Main

dist/
├── wordcounter.js      (6 KB)
└── wordcounter.min.js  (3 KB)

Getting started

Quick start

Three quick start options are available:

Download the latest release.
Clone the repository: git clone https://github.com/fengyuanchen/wordcounter.git.
Install with NPM: npm install wordcounter.

Usage

Browser

<script src="/path/to/wordcounter.js"></script>

var wordcounter = new WordCounter(options);

wordcounter.count(source, function (result, logs) {
  console.log(result); // Array
  console.log(logs); // String
});

NodeJS

var fs = require('fs');
var WordCounter = require('wordcounter');
var wordcounter = new WordCounter(options);

fs.readFile('/path/to/source.txt', function(err, data) {
  if (err) {
    throw err;
  }

  data = wordcounter.count(data.toString());

  fs.writeFile('/path/to/result.json', JSON.stringify(data), function (err) {
    if (err) {
      throw err;
    }

    console.log('Done, without errors.');
  });
});

Options

mincount

Type: Number
Default: 1

Min word count. If a word's count is less than this number, then it will be ignored.

minlength

Type: Number
Default: 1

Min word length. If a word's length is less than this number, then it will be ignored.

report

Type: Boolean
Default: true

Reports counting result in console.

ignore

Type: Array
Default: []
Example: ['this', 'return', 'function']

Ignores words.

ignorecase

Type: Boolean
Default: false

Ignores words' cases, treating them as lower case.

Methods

setup(options)

Params	Type	Description
options	`Object`	Custom options

Changes the default options.

count(source[, callback]])

Params	Type	Description
source	`String`	The source text for counting,
callback	`Function`	For example: `function (result, logs) {}`

Counts words from the source text, returns a words array.

Example

var source = 'foo fubar fubar bar quux QuUx quux norf norf';
var wordcounter = new WordCounter({
      mincount: 2,
      minlength: 4,
      ignore: ['norf'],
      ignorecase: true
    });

wordcounter.count(source, function (result, logs) {
  console.log(result);
  /*
  [{
    word: 'quux',
    count: 3
  }, {
    word: 'fubar',
    count: 2
  }]
  */

  console.log(logs);
  /*
  1> quux: 3
  2> fubar: 2
  */
});

Browser support

Chrome (latest)
Firefox (latest)
Safari (latest)
Opera (latest)
Edge (latest)
Internet Explorer 8+

Versioning

Maintained under the Semantic Versioning guidelines.

wordcounterdeprecated

Usage no npm install needed!