JavaScript API modules
Oro Runtime exposes native capabilities as explicit ES module imports under the
oro:* namespace. Treat those imports as the boundary between ordinary web code
and host capabilities.
Use this page when you need to find the right API family or confirm a public subpath import.
Start here#
| Need | Primary modules |
|---|---|
| App shell, windows, lifecycle | oro:application, oro:window, oro:hooks, oro:navigation |
| Files, paths, process state | oro:fs, oro:path, oro:os, oro:process |
| User-facing desktop behavior | oro:notification, oro:clipboard, oro:secure-storage |
| Network and HTTP work | oro:fetch, oro:http, oro:https, oro:net, oro:tls |
| Local data and formats | oro:sqlite, oro:url, oro:buffer, oro:stream, oro:toml |
| Background work and automation | oro:worker, oro:worker_threads, oro:service-worker, oro:shared-worker, oro:mcp, oro:ai |
API families#
Application shell and lifecycle#
oro:application— app/window management, menus, runtime metadata, and update hooks.oro:window— per-window operations and hotkeys.oro:hooks— lifecycle, notification, online/offline, and deep-link subscriptions.oro:navigation— runtime navigation state.oro:notification— notifications and permissions.
Filesystem, process, and platform#
oro:fs— filesystem APIs, includingoro:fs/promises.oro:path— cross-platform path handling.oro:os— platform, CPU, temporary-directory, and system metadata.oro:process— runtime process state, env access, signals, and scheduling helpers.oro:child_process— subprocesses.oro:clipboard— clipboard text operations.
Network and transport#
oro:fetch— fetch stack and request/response primitives.oro:http,oro:https— Node-compatible HTTP client/server APIs.oro:net,oro:tcp,oro:dgram,oro:dns,oro:tls— lower-level network APIs.oro:network,oro:latica,oro:iroh,oro:ipfs— higher-level transport and peer-to-peer surfaces.
Data, storage, and formats#
oro:sqlite— SQLite databases.oro:secure-storage— origin-scoped secret storage.oro:buffer,oro:stream,oro:string_decoder— byte and stream primitives.oro:url,oro:querystring,oro:mime,oro:toml,oro:semver,oro:tar,oro:zlib— data formats and encoding helpers.
Security, identity, and diagnostics#
oro:crypto— hashing, random bytes, and sodium-backed helpers.oro:cookies,oro:did— identity and web state helpers.oro:assert,oro:errors,oro:errno,oro:diagnostics,oro:console— correctness and inspection surfaces.
Device and host integration#
oro:usb,oro:hci,oro:dbus,oro:xpc— platform and device integration.oro:extension,oro:cdp,oro:protocol-handlers— host extension, inspection, and routing surfaces.
Workers, automation, and advanced runtime surfaces#
oro:worker,oro:worker_threads,oro:service-worker,oro:shared-worker,oro:background— worker contexts and native cleanup; background does not run arbitrary JavaScript.oro:mcp,oro:ai,oro:test— automation, local AI, and test harnesses.oro:commonjs,oro:module,oro:npm/module,oro:npm/service-worker,oro:vm— loader and compatibility APIs.
Native platform services in Runtime 0.2#
oro:platform— compiled backend discovery and custom extension requests.oro:authenticationandoro:credentials— authentication-bound key operations and explicit password-provider selection.oro:foreground,oro:foreground/continuous, andoro:background/deferred— registered native execution; not arbitrary background JavaScript.oro:push— native UnifiedPush registration, bounded journals, and recovery.oro:workflowsandoro:migration— Android-only high-level executors.oro:document-access,oro:launcher,oro:network-status, andoro:haptics— provider grants, destinations, OS network paths, and optional Android feedback.oro:window/appearanceandoro:window/back— native insets, gestures, and bounded Back handling.
Check native platform services for backend availability and the 0.2 release guide for upgrade requirements.
Complete public specifier reference#
This inventory is generated from the same published declarations as the family references.
All public module specifiers, grouped by family
| API family | Public imports |
|---|---|
oro:ai |
oro:ai, oro:ai/ann, oro:ai/chat, oro:ai/llm, oro:ai/whisper |
oro:application |
oro:application, oro:application/client, oro:application/menu, oro:application/update |
oro:asn1 |
oro:asn1 |
oro:assert |
oro:assert |
oro:async |
oro:async, oro:async/context, oro:async/deferred, oro:async/hooks, oro:async/resource, oro:async/storage, oro:async/wrap |
oro:async_hooks |
oro:async_hooks |
oro:authentication |
oro:authentication |
oro:background |
oro:background, oro:background/deferred |
oro:buffer |
oro:buffer |
oro:cdp |
oro:cdp |
oro:child_process |
oro:child_process, oro:child_process/worker |
oro:clipboard |
oro:clipboard |
oro:commonjs |
oro:commonjs, oro:commonjs/builtins, oro:commonjs/cache, oro:commonjs/loader, oro:commonjs/module, oro:commonjs/package, oro:commonjs/require |
oro:conduit |
oro:conduit |
oro:console |
oro:console |
oro:constants |
oro:constants |
oro:cookies |
oro:cookies |
oro:credentials |
oro:credentials |
oro:crypto |
oro:crypto, oro:crypto/sodium |
oro:dbus |
oro:dbus |
oro:dgram |
oro:dgram |
oro:diagnostics |
oro:diagnostics, oro:diagnostics/channels, oro:diagnostics/index, oro:diagnostics/metric, oro:diagnostics/runtime, oro:diagnostics/window |
oro:did |
oro:did, oro:did/index |
oro:dns |
oro:dns, oro:dns/constants, oro:dns/index, oro:dns/promises, oro:dns/utils |
oro:document-access |
oro:document-access |
oro:enumeration |
oro:enumeration |
oro:errno |
oro:errno |
oro:errors |
oro:errors |
oro:events |
oro:events |
oro:extension |
oro:extension |
oro:fetch |
oro:fetch, oro:fetch/fetch, oro:fetch/index |
oro:foreground |
oro:foreground, oro:foreground/continuous |
oro:fs |
oro:fs, oro:fs/bookmarks, oro:fs/constants, oro:fs/dir, oro:fs/fds, oro:fs/flags, oro:fs/handle, oro:fs/index, oro:fs/promises, oro:fs/stats, oro:fs/stream, oro:fs/watcher, oro:fs/web |
oro:gc |
oro:gc |
oro:haptics |
oro:haptics |
oro:hci |
oro:hci |
oro:hooks |
oro:hooks |
oro:http |
oro:http, oro:http/adapters |
oro:https |
oro:https |
oro:i18n |
oro:i18n |
oro:ip |
oro:ip |
oro:ipc |
oro:ipc |
oro:ipfs |
oro:ipfs |
oro:iroh |
oro:iroh |
oro:language |
oro:language |
oro:latica |
oro:latica, oro:latica/api, oro:latica/cache, oro:latica/encryption, oro:latica/index, oro:latica/nat, oro:latica/packets, oro:latica/proxy, oro:latica/worker |
oro:launcher |
oro:launcher |
oro:location |
oro:location |
oro:mcp |
oro:mcp, oro:mcp/index |
oro:migration |
oro:migration |
oro:mime |
oro:mime, oro:mime/index, oro:mime/params, oro:mime/type |
oro:module |
oro:module |
oro:navigation |
oro:navigation, oro:navigation/navigation |
oro:net |
oro:net |
oro:network |
oro:network |
oro:network-status |
oro:network-status |
oro:notification |
oro:notification |
oro:npm |
oro:npm/module, oro:npm/service-worker |
oro:os |
oro:os, oro:os/constants |
oro:path |
oro:path, oro:path/index, oro:path/mounts, oro:path/path, oro:path/posix, oro:path/well-known, oro:path/win32 |
oro:platform |
oro:platform |
oro:process |
oro:process, oro:process/signal |
oro:protocol-handlers |
oro:protocol-handlers |
oro:push |
oro:push |
oro:querystring |
oro:querystring |
oro:secure-storage |
oro:secure-storage |
oro:semver |
oro:semver |
oro:service-worker |
oro:service-worker, oro:service-worker/clients, oro:service-worker/container, oro:service-worker/context, oro:service-worker/debug, oro:service-worker/env, oro:service-worker/events, oro:service-worker/global, oro:service-worker/init, oro:service-worker/instance, oro:service-worker/notification, oro:service-worker/registration, oro:service-worker/state, oro:service-worker/storage, oro:service-worker/worker |
oro:shared-worker |
oro:shared-worker, oro:shared-worker/debug, oro:shared-worker/global, oro:shared-worker/index, oro:shared-worker/init, oro:shared-worker/state, oro:shared-worker/worker |
oro:signal |
oro:signal |
oro:sqlite |
oro:sqlite |
oro:stream |
oro:stream, oro:stream/web |
oro:string_decoder |
oro:string_decoder |
oro:tar |
oro:tar |
oro:tcp |
oro:tcp |
oro:test |
oro:test, oro:test/context, oro:test/dom-helpers, oro:test/fast-deep-equal, oro:test/harness, oro:test/index |
oro:timers |
oro:timers, oro:timers/index, oro:timers/platform, oro:timers/promises, oro:timers/scheduler, oro:timers/timer |
oro:tls |
oro:tls |
oro:toml |
oro:toml |
oro:tty |
oro:tty |
oro:url |
oro:url, oro:url/index, oro:url/url/url, oro:url/urlpattern/urlpattern |
oro:usb |
oro:usb |
oro:util |
oro:util, oro:util/types |
oro:vm |
oro:vm, oro:vm/init, oro:vm/worker, oro:vm/world |
oro:window |
oro:window, oro:window/appearance, oro:window/back, oro:window/constants, oro:window/hotkey |
oro:worker |
oro:worker |
oro:worker_threads |
oro:worker_threads, oro:worker_threads/init |
oro:workflows |
oro:workflows |
oro:xpc |
oro:xpc |
oro:zlib |
oro:zlib |
Notes#
- The authoritative surface is the runtime’s published TypeScript declarations.
- This page excludes private implementation families and bundled third-party shims that are not part of the supported application-facing API.
- If you know the module name, use the docs search box or open the matching family page from the sidebar.
Source repository · Edit this page · View Markdown