rae-api
TypeScript icon, indicating that this package has built-in type declarations

1.5.3 • Public • Published

RAE-API

RAE API i modified from https://github.com/mgp25/RAE-API to nodejs

See examples folder for more information.

Installation

npm install rae-api

Usage

Importing rae class

const { RAE } = require('rae-api');

const rae = new RAE();

Enabling debug mode

const rae = new RAE(true); // prints https request

Getting Word Of The Day

const wotd = await new RAE().getWordOfTheDay();

const word = wotd.getHeader();
console.log(`La palabra del día es: ${word}\n`);

Getting the definitions from a word search

const rae = new RAE();
const search = await rae.searchWord('hola');
const wordId = search.getRes()[0].getId(); // gets 'hola' word id

const result = await rae.fetchWord(wordId); // fetches the word as object
const definitions = result.getDefinitions(); // gets all 'hola' definitions as Defintion[]
const first = definitions[0].getDefinition(); // gets the first 'hola' definition as string

Getting the definitions from a random word

const random = await new RAE().getRandomWord(); //fetches a random word
const definitions = random.getDefinitions(); // gets all definitions of random word as Definition[]
const first = definitions[0].getDefinition(); // gets the first definition of random word as string

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Package Sidebar

Install

npm i rae-api

Weekly Downloads

4

Version

1.5.3

License

ISC

Unpacked Size

22 kB

Total Files

23

Last publish

Collaborators

  • account0123