Skip to content

Latest commit

 

History

History
132 lines (83 loc) · 4.54 KB

README-RU.md

File metadata and controls

132 lines (83 loc) · 4.54 KB
Raw

vot.js

GitHub Actions npm en ru

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

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

Установка

Установка для Bun:

bun add vot.js

Установка для NPM:

npm install vot.js

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

Для начала работы с 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.toil.cc",
});

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

Ограничения

  1. Библиотека не может переводить видео длинной более 4 часов
  2. Для перевода udemy, coursera, coursehunter и прочих сайтов, которые имеют авторизацию, вы должны создать свои собственные обработчики

Сборка

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

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

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

bun install

Сборка без обновления .proto

Данным вариантом сборки, следует пользоваться в большинстве случаев, если ваши изменения не затрагивают .proto файл.

bun build:bun

Сборка с обновлением .proto

Если вы хотите собрать библиотеку, обновив proto файлы, то вам необходимо установить protoc 3+ и добавить его в Path.

Сборка из под Linux (возможно, на MacOS, тоже, сработает):

bun rebuild:linux

Сборка из под Windows:

bun rebuild:win

Сборка TypeScript типов

Вы можете воспользоваться данным вариантом сборки, если вы хотите собрать, только, типы для TypeScript:

bun build:declaration

Сборка TypeBox типов

Вы можете воспользоваться данным вариантом сборки, если вы хотите собрать, только, типы для TypeBox:

bun build:typebox

Сборка только .proto файла

Вы можете воспользоваться данным вариантом сборки, если вы хотите, только, преобразовать .proto файл в .ts (это не обновит файл в папке /dist):

Сборка из под Linux (возможно, на MacOS, тоже, сработает):

bun build:proto-linux

Сборка из под Windows:

bun build:proto-win

Тесты

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

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

bun test