On this page
Overview
Creates an HTTP(S) navigation guard with explicit secure-mode domain and CIDR policy decisions.
- Artifact
ArcaneNavigationPolicy.js· esm - Classification
public first party - Availability
Cross-host - Normalization
Complete mutable allow/block decision; ordinary mode warns and continues, while explicitly selected secure:true fails closed.
Import and lifecycle
import * as module from '/arcane/modules/ArcaneNavigationPolicy.js';
The returned guard computes a complete mutable decision and awaits optional onDecision; it loads policy only when secure:true explicitly enables hardening, and it never navigates.
Application-facing behavior: createArcaneNavigationGuard({ secure }).
Protocol and host implementation
Arcane network-policy document This detail does not widen the application-facing API or grant authority.
Exports, signatures, parameters, and results
| Binding | Form | Declaration or signature | Parameter syntax |
|---|---|---|---|
createArcaneNavigationGuard | function | function createArcaneNavigationGuard({
secure=false,
loadPolicy=ArcaneNetworkPolicy.loadArcaneNetworkPolicy,
onDecision=null,
networkMatcher=ArcaneNetworkPolicy.findDeniedNetworkRule
}={}) | {
secure=false,
loadPolicy=ArcaneNetworkPolicy.loadArcaneNetworkPolicy,
onDecision=null,
networkMatcher=ArcaneNetworkPolicy.findDeniedNetworkRule
}={} |
| Callable | Kind | Exact public signature | Parameter syntax |
|---|---|---|---|
createArcaneNavigationGuard | exported-function | function createArcaneNavigationGuard({
secure=false,
loadPolicy=ArcaneNetworkPolicy.loadArcaneNetworkPolicy,
onDecision=null,
networkMatcher=ArcaneNetworkPolicy.findDeniedNetworkRule
}={}) | {
secure=false,
loadPolicy=ArcaneNetworkPolicy.loadArcaneNetworkPolicy,
onDecision=null,
networkMatcher=ArcaneNetworkPolicy.findDeniedNetworkRule
}={} |
Parameter meanings and results
createArcaneNavigationGuard({secure=false, loadPolicy, onDecision, networkMatcher}) returns async guard(value, context). The ordinary path permits valid HTTP(S) navigation with a warning. With secure:true, domain/CIDR matches block and policy or matcher failures fail closed as policy-unavailable decisions.
Events, side effects, and errors
Source-literal CustomEvent dispatches
No source-literal CustomEvent dispatch is part of this artifact.
Lifecycle and event flow
This artifact has no additional documented lifecycle event flow.
Direct coded failures
ARCANE_NETWORK_POLICY_MATCHER_UNAVAILABLEARCANE_NETWORK_POLICY_HOSTNAME_NONCANONICAL
Exported Error subclasses
This artifact exports no Error subclass.
Documented failure behavior
- TypeError for a non-HTTP(S) or unparseable destination before policy evaluation
Availability and capabilities
Cross-host. Complete mutable allow/block decision; ordinary mode warns and continues, while explicitly selected secure:true fails closed.
Cross-host navigation decision with optional shared deny-policy hardening; callers or Core own the actual navigation.
Contract example
import {createArcaneNavigationGuard} from '/arcane/modules/ArcaneNavigationPolicy.js';
const guard=createArcaneNavigationGuard({
secure:true,
loadPolicy:async()=>emptyArcaneNetworkPolicy()
});
console.log(await guard('https://example.com/docs',{intent:'external'}));
Related reference
No direct Core call is claimed for this artifact. Any injected provider or consuming module retains its own documented authority.