Interface BuildOptions

interface BuildOptions {
    eagerLinking?: boolean;
    validation?: boolean | ValidationOptions;
}

Hierarchy (view full)

Properties

eagerLinking?: boolean

Control the linking and references indexing phase with this option. The default if not specified is true. If set to false, references can still be resolved - that's done lazily when you access the ref property of a reference. But you won't get any diagnostics for linking errors and the references won't be considered when updating other documents.

validation?: boolean | ValidationOptions

Control the validation phase with this option:

  • true enables all validation checks and forces revalidating the documents
  • false or undefined disables all validation checks
  • An object runs only the necessary validation checks; the categories property restricts this to a specific subset