Nerds Publishing Monstrosities

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

    1.2.4 • Public • Published

    RAE-API

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

    See examples folder for more information.

    Update: API finished!!!

    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 = defintions[0].getDefinition(); // gets the first 'hola' definition 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

    Install

    npm i rae-api

    DownloadsWeekly Downloads

    209

    Version

    1.2.4

    License

    ISC

    Unpacked Size

    21.2 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar