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-lib

v1.0.7

Published

Check if a word exists in English, or retrieve a random word.

Downloads

11

Readme

word-lib

word-lib is a type-safe word library that can be used offline and is based off of @Brandons42's word-exists. This was built with the intent of adding typesafety, making it easier to add new languages, and allowing for different ways to query for words in js or ts based applications.

word-lib is currently in production use on my game Word Wurm.

Table of contents

Install

$ npm install word-lib --save

or

$ yarn add word-lib

Usage

Check if a word exists -- white space is trimmed, compares against lower-case. Hyphenated compound words aren't counted as words.

import wordLib from "word-lib";

wordLib.exists("word"); // true
wordLib.exists("library"); // true
wordLib.exists(" space "); // true

wordLib.exists("xyz"); // false
wordLib.exists("not-a-word"); // false
wordLib.exists("two words"); // false

wordLib.exists("a"); // false
wordLib.exists("a", { allowOneLetterWords: true }); // true

exists

word: string

The word that is being checked to exist

options?: IOption

allowOneLetterWords: boolean

If true, will treat a and i as one letter words. (defaults to false)


Get a random word from the dictionary. Minimum 3 letters long.

import wordLib from "word-lib";

wordLib.random(); // any possible word
wordLib.random(5); // generate a random word with a max length of 5

random

maxLength?: number

Sets the max length of the random word that can be found


Change current language, defaults to english (en). No other languages are currently supported.

import wordLib from "word-lib";

wordLib.setLanguage("en"); // set current language to english

setLanguage

languageCode: string

The language code the dictionary should be set to


License

Licensed under

Contribute

Any PR's for improvements, missing words or other language support are always welcome.

Adding a new language

To add a new language create a new folder within the /src/dictionary directory as the name of the language in ISO 639-1 format. Then add the language json file under that directory as {languageCode}.json and add the language code to the allowedLanguages to enable it. Look at the current dictionary example for reference.