README-RU.md

vot.js

Неофициальная библиотека для взаимодействия с Yandex VOT API, которая поддерживает работу с JavaScript, TypeScript, а так же имеет некоторые встроенные типы для Typebox.

Библиотека поддерживает работу с воркер-серверами, для этого необходимо создать клиент VOTWorkerClient и указать домен воркер-сервера, например vot-worker.toil.cc.

Установка

Для работы с Node, Bun или другими рантаймами установите библиотеку @vot.js/node:

bun install @vot.js/node

Для разработки браузерных расширений установите библиотеку @vot.js/ext:

bun install @vot.js/ext

Если вам нужна только часть функционала используйте библиотеки @vot.js/core и @vot.js/shared

Начало работы

Для начала работы с API необходимо создать VOT Client. Это можно сделать с помощью пары строчек представленных ниже.

Стандартный клиент:

const client = new VOTClient();

const videoData = await client.getVideoData("https://youtu.be/LK6nLR1bzpI");

const result = await client.translateVideo({ videoData });

Проксирование через vot-worker:

const client = new VOTWorkerClient({
  host: "vot-worker.toil.cc",
});

Больше примеров кода вы можете увидеть здесь

Ограничения

1. Библиотека не может переводить видео длинной более 4 часов

Сборка

Для сборки необходимо наличие:

• Bun
• Protoc (если собираете с обновлением .proto файла)

Не забудьте установить зависимости:

bun install

Запустите сборку:

bun build:all

Тесты

Библиотека имеет минимальное покрытие тестами для проверки ее работоспособности.

Запустить тесты:

bun test