API Host Reference

.NET Host API Reference

Applies to AuroraScript.JIT 4.0.0.

API Reference · Host Integration

This directory lists every public host type recorded in the current host-api.json. Each type has its own page with a simple usage sample: core integration types provide directly usable C# examples, while lower-level runtime types also list their complete public signatures, parameters, returns, and call shapes.

New integrations usually need only AuroraEngine, EngineOptions, ScriptSources, ScriptDomain, ScriptGlobal, and ScriptDatum.

On This Page

• Engine and Configuration
• Sources and Resolution
• Execution, Modules, and Hot Patching
• Script Values and Runtime Objects
• CLR Interop and Callbacks
• Serialization, Diagnostics, and Exceptions
• Usage Boundaries

Engine and Configuration

Engine entry points:

• AuroraEngine
• EngineOptions

Opt-in native modules:

• BuiltInModules
• BuiltInModuleDefinition
• BuiltInModulesBuilder

Option objects:

• RuntimeOptions
• CompilerOptions
• OptimizationOptions
• OutputOptions
• CompileBlockOptions

Option builders:

• RuntimeOptionsBuilder
• CompilerOptionsBuilder
• OptimizationOptionsBuilder
• OutputOptionsBuilder

Compilation results and enumerations:

• CompiledBlock
• CompilationMode
• OptimizeOptions
• StringPoolingStrategy

Sources and Resolution

Entry points and contracts:

• ScriptSources
• IScriptSourceResolver

Source descriptors and lookup:

• ScriptSource
• ScriptSourceReference
• ScriptSourceQuery
• ScriptResolveContext
• MemorySource

Built-in resolvers:

• MemorySourceResolver
• FileSystemScriptSourceResolver
• FileScriptSourceResolver
• CompositeScriptSourceResolver

Execution, Modules, and Hot Patching

• ScriptDomain
• ScriptContext
• ScriptGlobal
• ScriptModule
• ClosureFunction
• HotPatchType

Script-facing shipped modules are documented separately as fs and http.

Resolved ScriptSourceReference.FullPath is module identity. @module(NAME); adds only the explicit label used by ScriptDomain.Execute, GetMethod, GetModule, and script global.getModule; anonymous modules remain importable by path.

Script Values and Runtime Objects

Value model:

• ScriptDatum
• ValueKind
• ScriptType

Objects and collections:

• ScriptObject
• ObjectFlags
• ScriptArray
• ScriptHashMap
• ScriptEnumerator

Primitive and text values:

• StringValue
• NumberValue
• BooleanValue
• NullValue
• StringBuffer

Specialized values:

• ScriptDate
• ScriptRegex
• ScriptProxy
• ScriptError

CLR Interop and Callbacks

Type registration and marshalling:

• ClrTypeRegistry
• ClrType
• ClrInstanceObject
• ClrMarshaller
• TypeAccess

Bonding objects and delegates:

• BondingFunction
• BondingGetter
• ClrDatumDelegate
• ClrGetterDelegate
• ScriptFunctionDelegate
• ScriptMethodDelegate

Extension helpers:

• Extended

Serialization, Diagnostics, and Exceptions

Typed documents:

• AuroraTypedDocument
• TypedDocumentSerializer
• TypedDocumentOptions
• TypedDocumentException

JSON and debugger serialization:

• ScriptJsonSerializer
• StandardScriptJsonSerializer
• DebuggerScriptSerializer

Exceptions and diagnostics:

• Exceptions Overview
• AuroraException
• AuroraCompilationException
• AuroraRuntimeException
• AuroraCompilationDiagnostic
• AuroraStackTrace
• SourceSpan

Usage Boundaries

• Most host integrations can be built entirely from AuroraEngine, EngineOptions, ScriptDomain, ScriptSources, ScriptGlobal, and ScriptDatum.
• Runtime.Types, raw delegates, and resolver implementation types target advanced integrations. When using them, the host is responsible for thread safety, object lifetime, and compatibility validation.
• For end-to-end examples of wiring these types together, see Host Integration; for compilation-mode trade-offs, see Performance and Benchmarks.