Code Monkey home page Code Monkey logo

reverso-api's Introduction

Reverso API

version downloads telegram chat

logotype

Translate, get context examples or synonyms of words - this and much more you can do with your text queries via this API wrapper.

Navigation

Installing

$ npm i reverso-api

Usage

const Reverso = require('reverso-api')
const reverso = new Reverso()

Congrats! You can use all the available methods now.
Let's read through the README and find out how the things work.

You can pass either callback function...

reverso.getContext(...params, (err, response) => {
    ...
})

or use .then() function.

reverso.getContext(...params).then((response) => {
    ...
})

All the examples below are given using callback function.

Examples

getContext

reverso.getContext(
    'meet me half way',
    'english',
    'russian',
    (err, response) => {
        if (err) throw new Error(err.message)

        console.log(response)
    }
)

Response:

{
    ok: Boolean,
    text: String,
    source: String,
    target: String,
    translations: [String, ...],
    examples: [
        {
            id: Number,
            source: String,
            target: String
        },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

getSpellCheck

reverso.getSpellCheck('helo', 'english', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: Boolean,
    text: String,
    sentences: [ { startIndex: Number, endIndex: Number, status: String } ... ],
    stats: {
        textLength: Number,
        wordCount: Number,
        sentenceCount: Number,
        longestSentence: Number,
    },
    corrections: [
        {
            id: Number,
            text: String,
            type: String,
            explanation: String,
            corrected: String,
            suggestions: [
                {
                    text: String,
                    definition: String,
                    category: String,
                },
                ...
            ],
        },
    ]
}

Error:

{ ok: Boolean, message: String }

getSynonyms

reverso.getSynonyms('dzień dobry', 'polish', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: true,
    text: String,
    source: String,
    synonyms: [
        { id: Number, synonym: String },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

getTranslation

⚠️ WARNING: eventually, your server's IP address might get banned by Reverso moderators and you won't receive any data.

reverso.getTranslation(
    'how is going?',
    'english',
    'chinese',
    (err, response) => {
        if (err) throw new Error(err.message)

        console.log(response)
    }
)

Response:

{
    text: String,
    source: String,
    target: String,
    translations: [String, ...],
    context: {
        examples: [
            {
                source: String,
                target: String,
                source_phrases: [
                    {
                        phrase: String,
                        offset: Number,
                        length: Number
                    },
                    ...
                ],
                target_phrases: [
                    {
                        phrase: String,
                        offset: Number,
                        length: Number
                    },
                    ...
                ]
            },
            ...
        ],
        rude: Boolean
    }, // or null
    detected_language: String,
    voice: String // or null
}

Error:

{ ok: Boolean, message: String }

getConjugation

reverso.getConjugation('идти', 'russian', (err, response) => {
    if (err) throw new Error(err.message)

    console.log(response)
})

Response:

{
    ok: Boolean,
    infinitive: String,
    verbForms: [
        {
            id: Number,
            conjugation: String,
            verbs: [String, ...],
        },
        ...
    ]
}

Error:

{ ok: Boolean, message: String }

Credits

reverso-api's People

Contributors

s0ftik3 avatar gustawdaniel avatar mgyucht avatar sk8guerra avatar ddeluc avatar atipi132 avatar louisrli avatar koynoyno avatar mathias4833 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.