API Host CompilerOptions

CompilerOptions

Compiler input and compilation mode settings.

Namespace: AuroraScript. Kind: record.

Back to .NET Host API Reference

Overview

CompilerOptions controls where scripts are read from, which compilation mode is used, and module compilation parallelism. The record is immutable; set it through EngineOptions.WithCompiler, which hands a CompilerOptionsBuilder to the callback.

Quick Reference

A minimal use of CompilerOptions.

var options = EngineOptions.Default.WithCompiler(builder => builder
    .WithMode(CompilationMode.Dynamic)
    .WithExtName(".as")
    .WithMaxDegreeOfParallelism(4)
    .WithSourceResolver(ScriptSources.FileSystem("scripts")));

Fields

Default

static readonly CompilerOptions Default

Default compiler configuration.

Parameters

None.

Returns

Returns CompilerOptions.

var options = CompilerOptions.Default;

Properties

Mode

CompilationMode Mode

Emit strategy for compiled scripts.

Parameters

None.

Returns

Returns CompilationMode.

var mode = EngineOptions.Default.Compiler.Mode;

ExtName

string ExtName

Script extension enumerated by the resolver.

Parameters

None.

Returns

Returns string.

var extension = EngineOptions.Default.Compiler.ExtName;

MaxDegreeOfParallelism

int MaxDegreeOfParallelism

Module compilation parallelism.

Parameters

None.

Returns

Returns int.

var parallelism = EngineOptions.Default.Compiler.MaxDegreeOfParallelism;

SourceResolver

IScriptSourceResolver SourceResolver

Resolver used to locate and load entry, import, and include sources.

Parameters

None.

Returns

Returns IScriptSourceResolver.

var options = EngineOptions.Default.WithCompiler(builder =>
    builder.SourceResolver = ScriptSources.FileSystem("scripts"));