Skip to content

📦 Exports

All public exports from vue-router-citadel.

📋 Common Imports

typescript
import {
  createNavigationCitadel,
  NavigationOutpostScopes,
  NavigationHooks,
  NavigationOutpostVerdicts,
  type NavigationOutpost,
  type NavigationOutpostHandler,
} from 'vue-router-citadel';

🔢 Constants

typescript
import {
  NavigationOutpostScopes,
  NavigationHooks,
  NavigationOutpostVerdicts,
  DebugPoints,
} from 'vue-router-citadel';
ConstantValuesDescription
NavigationOutpostScopesGLOBAL, ROUTEOutpost scope determining when it's processed
NavigationHooksBEFORE_EACH, BEFORE_RESOLVE, AFTER_EACHVue Router navigation hooks
NavigationOutpostVerdictsALLOW, BLOCKHandler return verdicts
DebugPointsNAVIGATION_START, OUTPOST_ENTER, etc.Named debug breakpoint identifiers

🏷️ Types

typescript
import type {
  NavigationOutpostContext,
  NavigationOutpostHandler,
  NavigationOutpost,
  NavigationCitadelOptions,
  NavigationCitadelAPI,
  NavigationHook,
  NavigationOutpostScope,
  CitadelLogger,
  // Lazy loading
  LazyOutpostLoader,
  // Debug types
  DebugHandler,
  DebugPoint,
  // Type-safe outpost names
  GlobalOutpostRegistry,
  RouteOutpostRegistry,
  GlobalOutpostName,
  RouteOutpostName,
  OutpostName,
} from 'vue-router-citadel';

See Types for detailed type definitions.

🔧 Utility Functions

typescript
import {
  createDefaultLogger, // Factory for default console logger
  createDefaultDebugHandler, // Factory for default debug handler
} from 'vue-router-citadel';
FunctionReturnsDescription
createDefaultLogger()CitadelLoggerConsole logger with emoji prefixes
createDefaultDebugHandler()DebugHandlerDefault handler that triggers debugger

Released under the MIT License.