wordcage

A JavaScript library for analyzing text strings.

Installation

Web browser

In vanilla, a wordcage global is exported. You can use the latest version from unpkg.

<script src="https://unpkg.com/[email protected]/build/wordcage.js"></script>
<script src="https://unpkg.com/[email protected]/build/wordcage.min.js"></script>

If you'd rather host it yourself, download the latest release from the build directory.

npm

npm i wordcage -S

import wordcage from "wordcage";

const analyzer = new wordcage("The quick brown fox jumps over the lazy dog.")();
const words = analyzer.words();
const bigrams = analyzer.ngrams(2);
const trigrams = analyzer.ngrams(3);
const grouped = analyzer.group();

API

# wordcage(text)()

Creates a wordcage instance on the specified text, which must be a string.

# wordcage.words()

Returns an array of words.

# wordcage.ngrams([n])

Returns an array of n-grams of the specified n, which defaults to 2.

# wordcage.group([n])

Returns an JSON array of objects, each representing the frequency of entries of the specified n, which defaults to 1, i.e. individual words. You can also specify n as an array of numbers, in which case wordcage will calculate the frequencies of each n in the specified array.

const bigrams = analyzer.group(2);
const bigramsAndTrigrams = analyzer.group([2, 3]);

Each object has the following properties:

|property|type |description | |--------|-------|---------------------------------------------------------| |entry |String |The entry, either a single word or an n-gram of length n.| |count |Number |The number of appearances of the entry in the text. | |pct |Number |The entry's percentage of all entries in the text. | |stop |Boolean|Whether the entry is or contains a stop word. |

# wordcage.text()

Returns the wordcage instance's specific text.

# wordcage.stops([words])

If words is specified, sets the analyzer's stop words to the specified words, which should be an array of lowercase stop words, and returns the analyzer. If words is not specified, returns the array of default stop words.