TypeScript API reference

The TypeScript reference is generated from the published type declarations (.d.ts) of the pinned package versions, so it describes what you install.

Tested set: IndeRun 0.5.0-rc.17 (@independo/inderun-web, SwiftPM, Maven) and @independo/capacitor-inderun 1.2.0, which wraps IndeRun 0.4.0. Examples type-checked against these on 2026-11-10.

• Capacitor plugin reference: @independo/capacitor-inderun, the package most apps start with. Its source of truth is src/definitions.ts (opens in new tab) at v1.2.0.
• Web SDK reference: @independo/inderun-web.

Start here (Capacitor)

The generated index lists every exported type alphabetically. These are the entry points an app uses:

Name	What it is
createIndeRunCapacitor	Creates the instance your app calls.
run	Runs one task and resolves with its result, or rejects with an IndeRunError.
stream	Runs one task and delivers its output as events.
checkCapabilities	Reports what each provider can do on this device right now.
ConfigureOptions	Options for createIndeRunCapacitor, such as a cloud provider.
TaskRequest	What you pass to run and stream, including constraints.privacy.
TaskResult	What run resolves with.
ExecutionProvenance	Where the task ran (providerId, locality).
IndeRunError	The normalized error, with errorClass and details.

The other entries are contract and host-service types that these refer to.

These two references are generated when the site is built, so the links above work only on the site. Reading this on GitHub? Open them at https://inderun.dev/docs/api/typescript.

The Capacitor plugin wraps an older IndeRun release than the Web SDK, so the two references can differ. The versions above are the ones this site was checked against.

Swift and Kotlin

References for the Swift and Kotlin SDKs are not generated. Use their READMEs instead: IndeRun for Swift (opens in new tab) and IndeRun for Kotlin (opens in new tab).