-
Notifications
You must be signed in to change notification settings - Fork 0
API Reference
Liu.Yandong.Hanks edited this page Aug 21, 2026
·
4 revisions
Applies to AuroraScript.JIT 4.0.0.
This page is the entry point for AuroraScript's public contracts. The reference is split by audience and contract type, and every object or type has its own page instead of being collected into one long article.
| Hub | Audience | Contents |
|---|---|---|
| Script API Reference | Script authors | Every script global, constructor, static member, and instance member. |
| .NET Host API Reference | .NET host developers | Engine, configuration, domains, source resolution, CLR interop, runtime values, diagnostics. |
| Typed Document (TDoc) Format | Both | Text syntax, type fidelity, read-only properties, CLR/CIL registration boundaries, script and host entry points. |
| MCP Tools and Resources | AI clients and tooling | Tools, resources, inputs, outputs, and invocation examples. |
- Look up a script object, method, or operator: Script API Reference.
- Configure compilation, optimization, or output: .NET Host API Reference.
- Load scripts from files, memory, or a custom source: .NET Host API Reference.
- Exchange values between scripts and C#: .NET Host API Reference.
- Expose CLR types or callbacks to scripts: .NET Host API Reference.
- Read or write typed documents: TDoc script API and TDoc format.
- Diagnose compilation or runtime failures: .NET Host API Reference.
Reference pages provide:
- the full public signatures exposed by the corresponding schema,
- parameter types, optionality, and descriptions,
- return values,
- boundary, exception, or lifecycle behavior where it matters,
- focused examples for common usage,
- links back to the relevant reference hub.
Script API examples are written in AuroraScript; host API examples are written in C#.
AuroraScript.JIT 4.0.0 · Documentation Home · Repository · MIT License