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— background execution.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.
Complete public specifier reference#
The full public set is grouped below for search and exact subpath lookup. Most apps should use the primary family pages above instead of browsing this list line by line.
App shell and lifecycle
oro:application,oro:application/client,oro:application/menu,oro:application/updateoro:window,oro:window/constants,oro:window/hotkeyoro:hooksoro:navigation,oro:navigation/navigationoro:notificationoro:backgroundoro:location
Filesystem, process, and platform
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/weboro:path,oro:path/index,oro:path/mounts,oro:path/path,oro:path/posix,oro:path/well-known,oro:path/win32oro:os,oro:os/constantsoro:process,oro:process/signaloro:child_process,oro:child_process/workeroro:clipboardoro:ttyoro:signaloro:constants
Network and transport
oro:fetch,oro:fetch/fetch,oro:fetch/indexoro:http,oro:http/adaptersoro:httpsoro:netoro:tcporo:dgramoro:dns,oro:dns/constants,oro:dns/index,oro:dns/promises,oro:dns/utilsoro:tlsoro:networkoro:iporo:ipcoro:ipfsoro:irohoro:latica,oro:latica/api,oro:latica/cache,oro:latica/encryption,oro:latica/index,oro:latica/nat,oro:latica/packets,oro:latica/proxy,oro:latica/workeroro:conduit
Data, storage, and formats
oro:bufferoro:stream,oro:stream/weboro:string_decoderoro:sqliteoro:url,oro:url/index,oro:url/url/url,oro:url/urlpattern/urlpatternoro:querystringoro:mime,oro:mime/index,oro:mime/params,oro:mime/typeoro:tomloro:semveroro:taroro:zliboro:asn1oro:enumeration
Security, identity, diagnostics, and correctness
oro:secure-storageoro:crypto,oro:crypto/sodiumoro:cookiesoro:did,oro:did/indexoro:assertoro:errorsoro:errnooro:eventsoro:diagnostics,oro:diagnostics/channels,oro:diagnostics/index,oro:diagnostics/metric,oro:diagnostics/runtime,oro:diagnostics/windoworo:consoleoro:gc
Device and host integration
Workers, automation, loaders, and advanced runtime surfaces
oro:ai,oro:ai/ann,oro:ai/chat,oro:ai/llm,oro:ai/whisperoro:mcp,oro:mcp/indexoro:workeroro:worker_threads,oro:worker_threads/initoro: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/workeroro: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/workeroro:test,oro:test/context,oro:test/dom-helpers,oro:test/fast-deep-equal,oro:test/harness,oro:test/indexoro:timers,oro:timers/index,oro:timers/platform,oro:timers/promises,oro:timers/scheduler,oro:timers/timeroro:async,oro:async/context,oro:async/deferred,oro:async/hooks,oro:async/resource,oro:async/storage,oro:async/wrap,oro:async_hooksoro:commonjs,oro:commonjs/builtins,oro:commonjs/cache,oro:commonjs/loader,oro:commonjs/module,oro:commonjs/package,oro:commonjs/requireoro:moduleoro:npm/module,oro:npm/service-workeroro:vm,oro:vm/init,oro:vm/worldoro:util,oro:util/types
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