Public API Index

This index maps the public resuxjs package entry points to their focused documentation. The package exports and implementation are the source of truth; use the narrowest entry point that matches the environment and task.

resuxjs

The root entry re-exports the application-facing runtime surface, including:

• reactivity: ref, reactive, computed, watch, watchEffect, readonly, conversion/check helpers, and nextTick;
• state/data: useState, useGlobalState, useAsyncData, useFetch, $fetch, and apiURL;
• routing: useRoute, useRouter, navigateTo, and abortNavigation;
• app/config: useRuntimeConfig, useResuxApp, and application/plugin/module factories;
• head/errors: useHead, useSeoMeta, useError, createError, showError, and clearError;
• server helpers, package/client-enhancement helpers, device/i18n helpers, and useResuxImage().

Read Composables and Globals, Runtime Internals, and the conceptual guides for the feature you are using.

resuxjs/runtime

Advanced renderer/runtime APIs and types for component/template definitions, server setup, document rendering, routes/payloads, browser-runtime generation, client enhancements, media rendering, and runtime composables.

Primary reference: Runtime Internals.

resuxjs/reactivity

Focused Resux-native reactivity without the rest of the application runtime:

• effect() / stop();
• refs and conversion helpers;
• reactive/readonly proxies;
• computed values;
• watch() / watchEffect();
• nextTick();
• public ref/watch/effect types.

Primary reference: Reactivity API. Conceptual usage: State and Reactivity.

resuxjs/compiler

Node/build-time compiler APIs:

• buildProject();
• compileVueFile();
• compileVueSource();
• createRouteManifest();
• ResuxCompileError;
• compile/build/result/route/plugin/middleware/handler/island types.

Primary reference: Compiler API.

resuxjs/create

Node-only programmatic project creation/scaffolding and destructive-target safety validation.

Primary reference: Project Creation API. User workflow: Getting Started and CLI.

resuxjs/i18n

Optional i18n module/runtime surface, including public configuration types, useI18n(), locale-path helpers, defineI18nConfig(), and createI18nHeadEntry().

Primary reference: i18n API. Conceptual guide: i18n and Localization.

resuxjs/ui

Optional Vue UI/motion package:

• 23 public Rx* components plus matching Resux* aliases;
• module options and defineUiTokens();
• isReducedMotion() and useAnimate();
• vAnime / vAnimate.

Primary docs: UI component catalog and UI Package API.

resuxjs/icons

Optional Vue SVG icon package with a local path registry, Iconify-compatible client fetching, request caching/deduplication, lazy remote loading, module configuration, and helper types/functions.

Primary docs: Icons, Usage and Registry, Configuration, and Runtime Loading.

resuxjs/fonts

Google Fonts stylesheet-loader module and typed googleFont() family helper.

Primary docs: Fonts, Configuration, and Performance and CSP.

resuxjs/kit

Build/module-authoring helpers for components, imports, plugins, middleware, server handlers/plugins, generated templates/types, pages, runtime config, Vite/Nitro extension, route rules, and prerender routes.

Primary reference: Resux Kit API. Conceptual guide: Modules and Route Rules.

resuxjs/core

Low-level configuration resolver/constants, hook registry, module contribution container, and core app factory for builders/framework integrations.

Primary references: Core API and Lifecycle Hooks.

resuxjs/node

Focused production Node request-handler entry point exporting createResuxNodeHandler() and ResuxNodeHandlerOptions.

Primary reference: Node Handler API. Operational guide: Deployment.

resuxjs/halal

Halal Core policy, scanner/evaluator, lifecycle enforcement, runtime-content guard, signed reviewed-memory, AI classifier, integrity/report/CLI utilities and their related types.

Primary reference: Halal Core API. Conceptual/security guide: Halal Core.

resuxjs/globals

Type-only app-global declarations used by generated applications. Configure them through generated TypeScript/project types rather than importing this entry for runtime behavior.

Primary guide: TypeScript and Generated Types.

resuxjs/package.json

Package metadata export. Package-level documentation: Package Exports.

Keeping this index complete

When a public entry point or symbol changes:

1. verify the implementation/export first;
2. update or add its focused reference;
3. document parameters/types/defaults, environment and runtime/resumability limits where relevant;
4. cross-link the conceptual guide and API reference;
5. update Documentation Coverage.

The coverage map is intentionally human-reviewable today; it should not be treated as machine-enforced export coverage until CI actually implements that check.