Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.04 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.04 KB

yt-xml2vtt

A tiny module to easily convert YouTube caption format from XML to VTT with ZERO dependencies.

npm package

Installation

npm i -S yt-xml2vtt

Or for Yarn users:

yarn add yt-xml2vtt

Usage

Using Promises:

const xml2vtt = require('yt-xml2vtt');

xml2vtt.Parse(xmlString)
  .then(vtt => /* DO SOMETHING WITH VTT */)
  .catch(err => console.log(`Error while converting XML to VTT : ${err}`));

Or you can use async await

const xml2vtt = require('yt-xml2vtt');

const vtt = await xml2vtt
  .Parse(xmlString)
  .catch(err => console.log(`Error while converting XML to VTT : ${err}`));
/* DO SOMETHING WITH VTT */

Using it synchronously:

const xml2vtt = require('yt-xml2vtt');

try {
  const vtt = xml2vtt.ParseSync(xmlString);
  /* DO SOMETHING WITH VTT */
} catch (err) {
  console.log(`Error while converting XML to VTT : ${err}`);
}

Tests

npm test