illyria-scraper v1.1.1

illyria scraper

Installation

Just install the package using NPM

npm i --save illyria-scraper

Or using Yarn

yarn add illyria-scraper

And import it directly using CommonJS

const { getTranslationInfo } = require("illyria-scraper");

Or with the ES6 syntax

import { getTranslationInfo } from "illyria-scraper";

The package doesn't provide a default export, but you can alternatively use the wildcard import syntax

import * as IllyriaScraper from "illyria-scraper";

Usage

Main API

Translation text

getTranslationText(source: LangCode<"source">, target: LangCode<"target">, query: string): Promise<string | null>

Retrieves the translated text given a pair of languages and a query text.

import { getTranslationText } from "illyria-scraper";

const translation = await getTranslationText("auto", "es", "win");

Translation information

getTranslationInfo(source: LangCode<"source">, target: LangCode<"target">, query: string): Promise<TranslationInfo | null>

Retrieves the full translation information, optionally including the detected source, typos, pronunciation representations, definitions, examples, similar words or extra translations.

import { getTranslationInfo } from "illyria-scraper";

const info = await getTranslationInfo("zh", "en", "早安");

Text to speech

getAudio(lang: LangCode<"target">, text: string, isSlow?: boolean): Promise<number[] | null>

Retrieves an audio buffer in the form of a Uint8Array, and represented as a number[] in order to be serializable.

import { getAudio } from "illyria-scraper";

const audio = await getAudio("ca", "gerd");

Utilities

There are also some utility constants and functions exported in order to ease the use of the package.

• LanguageType

An enumeration representing the two language types (source and target) and very used among the rest of utilities.

import { LanguageType } from "illyria-scraper";

LanguageType.SOURCE // "source"
LanguageType.TARGET // "target"

• languageList

An object that includes the whole list of languages used in this package, as well as two other properties with the language list filtered by type.

import { languageList } from "illyria-scraper";

languageList.all // whole list
languageList.source // i.e. languageList[LanguageType.SOURCE]
languageList.target // i.e. languageList[LanguageType.TARGET]

• isValidCode()

A function that checks whether a string is a valid language code, optionally differentiating it based on a certain language type.

import { isValidCode } from "illyria-scraper";

const isValidLang = isValidCode(str);
const isValidSource = isValidCode(str, LanguageType.SOURCE);

• replaceExceptedCode()

A function that checks whether a language code is valid regarding a language type, and changes it with a suitable replacement if not.

import { replaceExceptedCode } from "illyria-scraper";

const targetLang = replaceExceptedCode(LanguageType.TARGET, lang);

• mapGoogleCode()

A function that maps the given illyria language code with a valid Google one, in case they're different.

import { mapGoogleCode } from "illyria-scraper";

const googleLang = mapGoogleCode(lang);

• mapillyriaCode()

A function that maps the given Google language code with a valid illyria one, in case they're different.

import { mapillyriaCode } from "illyria-scraper";

const lang = mapillyriaCode(googleLang);