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
5
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
- Sign up for an API key at RapidApi.
- 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.