Webview Bundle

API references for the Rust core, the Node and Deno bindings, and the web-side bridge.

Most app developers never touch these APIs directly. To ship Webview Bundle in an app, reach for the platform integration packages and follow the platform guides — they wrap the core for you. These references are for advanced and embedding use: hosting the core yourself, driving the Node or Deno bindings, or calling the native host from inside the webview.

Building an app? Start with the platform integration guide and pick your platform: Electron, Tauri, Android, iOS, or Deno Desktop.

API references

Rust API

The core wvb crate on docs.rs: the .wvb format, bundle sources, remote and updater, integrity, and signatures.

Node API

@wvb/node — N-API bindings for reading and writing bundles, serving them over a protocol, and running the updater from Node.js.

Deno API

@wvb/deno — the Deno peer of @wvb/node. Experimental.

Bridge

@wvb/bridge — call the native host from inside the webview with one invoke() API across every platform.

Web-side bridge

The bridge (@wvb/bridge) runs inside the webview and lets your web app call the native host. It exposes a single invoke() function plus typed source, remote, and updater helpers, so the same code works across Electron, Tauri, Android, and iOS — the per-platform transport is abstracted away. See the Bridge reference for the full API.

import { invoke, updater } from '@wvb/bridge';

// Typed domain helper
const update = await updater.getUpdate('my-app');
if (update.isAvailable) {
  await updater.download('my-app');
  await updater.install('my-app', update.version);
}

// Or call a command directly
const bundles = await invoke('sourceListBundles');

The native side hosts @wvb/node and answers these calls. For how the bridge fits into each platform, see the platform integration guide.

Other platforms

The Tauri and mobile integrations expose their own APIs, documented alongside their guides:

Tauri ships as the Rust crate wvb-tauri — see the Tauri guide.
Android (Kotlin) and iOS (Swift) bindings are covered in the Android guide and the iOS guide.

Overview