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

react-word-checker

v1.1.1

Published

React hook for checking if a word is a valid english word

Downloads

148

Readme

react-word-checker

A React Hook that allows you to check if any word is a valid word in English, Spanish, or French.

Credit to https://github.com/lorenbrichter/Words for the word lists.

Installation

$ npm install react-word-checker

Types

declare const useWordChecker: (language?: string) => {
    words: {
        [name: string]: boolean;
    };
    isLoading: boolean;
    wordExists: (word: string) => boolean;
};

API

useWordChecker() takes in a language code as an optional singular argument. This will default to en if nothing is given.

Options

  • en: English
  • es: Spanish
  • fr: French

Example

useWordChecker("en");
useWordChecker("fr");

Return values

  • words: An object with keys for all the words in the valid word list.
   {
       "apple": true,
       "banana": true,
       "word": true,
       ...
   }
  • isLoading: A boolean that returns whether the word list has been loaded or not.
  • wordExists(): A function that returns true if the word exists in the word list and false if it does not. Takes in a single string as an argument.

Usage Example

import { useWordChecker } from 'react-word-checker';

const MyComponent = () => {
  { words, isLoading, wordExists } = useWordChecker("en");

  useEffect(() => {
    if (!isLoading){
        console.log(wordExists("apple")); // returns true
        console.log(wordExists("ApPLe")); // returns true, function sets argument string to lowercase
        console.log(wordExists("asdasd")); // returns false
    }
  }, [isLoading]);
}

Contributing

Any contributions to improve this project are very welcome! Submit a PR and I will take a look.