API wrapper for YouTube, Vimeo, and self-hosted videos.

• Install
• Import VideoWorker
  • ESM
  • TypeScript
  • ESM CDN
  • UMD
  • UMD CDN
  • CommonJS
• Use VideoWorker
• Options
• Events
• Methods
• Custom Providers
• For Developers

npm install video-worker

Video Worker ships with:

• ESM and CommonJS entry points
• UMD bundles in dist/
• TypeScript declarations in dist/types/
• Published src/ files for compatibility with consumers that still inspect or bundle source paths

import VideoWorker from 'video-worker';

import VideoWorker, { type VideoWorkerOptions } from 'video-worker';

const options: VideoWorkerOptions = {
  autoplay: false,
  loop: false,
  mute: false,
  volume: 100,
  showControls: true,
  accessibilityHidden: false,
  startTime: 0,
  endTime: 0,
};

const video = new VideoWorker('https://www.youtube.com/watch?v=ab0TSkLe-E0', options);

<script type="module">
  import VideoWorker from "https://cdn.jsdelivr.net/npm/video-worker@2/+esm";
</script>

VideoWorker can also be used in a traditional browser setup through window.VideoWorker.

<script src="video-worker.min.js"></script>

<script src="https://cdn.jsdelivr.net/npm/video-worker@2/dist/video-worker.min.js"></script>

const VideoWorker = require('video-worker');

import VideoWorker from 'video-worker';

const videoObject = new VideoWorker('https://www.youtube.com/watch?v=ab0TSkLe-E0');

if (videoObject.isValid()) {
  videoObject.getVideo((video) => {
    const parent = video.parentNode;

    document.body.appendChild(video);

    if (parent?.parentNode) {
      parent.parentNode.removeChild(parent);
    }
  });
}

Supported URL examples:

• YouTube https://www.youtube.com/watch?v=ab0TSkLe-E0
• YouTube Shorts https://www.youtube.com/shorts/ab0TSkLe-E0
• Vimeo https://vimeo.com/110138539
• Self-hosted mp4:./self-hosted-video.mp4,webm:./self-hosted-video.webm,ogv:./self-hosted-video.ogv

For self-hosted videos, a single source is enough. Multiple formats are only needed for broader browser compatibility.

new VideoWorker('<URL_TO_YOUR_VIDEO>', {
  autoplay: true,
  loop: true,
  startTime: 10,
});

videoObject.on('ready', (event) => {
  console.log('video ready', event);
});

videoObject.mute();

Video Worker supports YouTube, Vimeo, and self-hosted videos out of the box. You can register custom providers without changing the factory API.

VideoWorker.providers.MyVideoProvider = class MyVideoProvider extends VideoWorker.BaseClass {
  type = 'my-video-provider';

  static parseURL(url) {
    return url.startsWith('custom:') ? url.slice('custom:'.length) : false;
  }
};

Provider implementations live in src/providers.

• Run npm install

• npm run dev to build in watch mode and serve the demo on port 3002

• npm run typecheck to validate TypeScript
• npm run lint to run Biome checks
• npm run lint:fix to apply safe Biome fixes
• npm run format to format files with Biome
• npm run format:check to verify formatting
• npm run test:run to run the test suite once
• npm run test:coverage to generate coverage output
• npm run test:artifacts to validate published build artifacts

• npm run build to generate all bundles and declaration files