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

vocabulary-js

v1.0.0

Published

Everybody and everything has a vocabulary. Users, actions, websites, ads, memes, etc. This tool can help you track and assess relevance between vocabularies and ensure your content will be interesting for your users.

Downloads

2

Readme

Vocabulary

Everybody and everything has a vocabulary. Users, actions, websites, ads, memes, etc. This tool can help you track and assess relevance between vocabularies and ensure your content will be interesting for your users.

Most humans and therefore most documents and websites have limited vocabularies, usually around 20,000 words and no more than 35,000 words and rarely more than 50,000 words. Vocabularies are typically much smaller than the documents they represent. A Vocabulary() is simply a hash table of all the words you've given it and how many times it's seen the same word. In this way, every word is ranked by the frequency and size of the word. Like any json object, you can store a vocabulary anyway you like. Given their small size, I cache them locally in window.localStorage and can store them permanently in a NoSql db if desired. You really only need to store a user's vocabulary as they click around your site, return, etc. A page's vocabulary should be created dynamically by the client and independently of the CMS, etc.

Vocabulary() can run on the server (Node) or the client (Javascript). It does not depend on jQuery or any other libraries, but is compatible of course.

Usage

It's just a tiny amount of javascript, so you can include it in the browser.

<html>
<head>...</head>
<body>
...
<script src="Vocabulary.js"></script>
</body>
</html>

or on the server

const Vocabulary = require('Vocabulary.js');

User Stories

As a user, I want to be "heard" and "known" as I click around your site(s), so that when your sight suggests other products, stories or opportunities they will be relevant to me and my demonstrated interests.

let userVocabulary = new Vocabulary();
userVocabulary.add("all the words on the page");
button.click(() => userVocabulary.add("some words associated with this button"));

As a programmer, I want to maintain a user's vocabulary and then present the user with relevant options in the dynamic components on the site.

let preferences = usersVocabulary.order("shoes hats underwear");
switch(preferences[0]) {
  case "shoes":
    displayShoes();
    break;
  case "hats":
    displayHats();
    break;
  case "underwear":
    displayUnderwear();
    break;
}

Class Definition

class Vocabulary {
    constructor(text){} // add initial words to my vocabulary
    add(text){} // add more words to my vocabulary, parse, etc.
    addString(word, count){} // add one word or phrase without parsing
    // count defaults to 1, unless you want to "seed" a word with a high count
    addVocabulary(that){} // combine two vocabularies
    rank(word){} // calculate the rank of a word being used in the vocabulary
    order(words){} // given a list of words, sort them in order of rank 
    relevance(that){} // calculate how relevant "that" vocabulary is to me
}

Tests

Run node tests

You'll need to install npm, node, and mocha to run these tests in a terminal https://www.npmjs.com/package/mocha

Contributing

Pull requests welcome! Please add unit tests to tests.js for any new functions.

Dependencies

None. Let's keep it that way please.

ISC License

Copyright (c) 2019 ChadSteele.com

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Author

Hire me! ChadSteele.com