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

wordsapi-wrapper

v1.0.5

Published

A TypeScript wrapper for the WordsAPI that provides easy access to word-related data such as definitions, pronunciations, rhymes, frequencies, and more.

Downloads

10

Readme

WordAPI Wrapper

A TypeScript wrapper for the WordsAPI that provides easy access to word-related data such as definitions, pronunciations, rhymes, frequencies, and more.

Features

  • Retrieve word details, including definitions, synonyms, antonyms, and more.
  • Get pronunciation data for a word.
  • Find rhymes for a word.
  • Check the frequency of a word's usage.
  • Perform word searches with customizable parameters.
  • Fetch random words for various word-related applications.

Usage

import { WordsApi } from "wordsapi-wrapper";

async function main() {
  const apiKey = "YOUR_API_KEY_HERE";
  const wordsApi = new WordsApi(apiKey);

  try {
    // Example: Get word definitions for "stairs"
    const definitions = await wordsApi.getWordDetail("stairs", "definitions");
    console.log(definitions);

    // You can use other methods provided by WordsApi as well.
  } catch (error) {
    console.error("Error:", error);
  }
}

main();

Installation

Install the package using npm:

npm install wordapi-wrapper

Getting Started

  1. Sign up for an API key at RapidApi.
  2. Import the WordsApi class and start using it to access word-related data in your applications.

Contributions

Contributions and bug reports are welcome! Feel free to open an issue or create a pull request to improve this wrapper.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Replace `"YOUR_API_KEY_HERE"` with your actual WordsAPI API key in the example code.