JaiScriptdocs
GitHub

Reference​

The lookup pages. The guide teaches the language and the embedding chapters teach the host API; come here for the exact rule, spelling or error text. An error text pasted into the search box lands on its catalogue row.

PageOpen it forSections
Language Rulesthe exact rule: operators, keywords, conversions, cast, extern, the checker attributes, include and import, and the contractual one-linersTwo spellings, one meaning · Operators · Keywords · Type conversions · The typed boundary · cast<T>(e), cast<T&>(e), cast<shared_ptr<T>>(e) · extern, inline, using · [[warn_mode]] and [[strict_mode]] · Language rules in one place · include vs import · Import modes (engine::import_behavior) · field order · top-level order
Errors and Diagnosticsan error text: how to read a static listing and a run-time error, the error kinds, and every catalogued text with when it is raised and the fixDiagnostics as you read them · The static listing (before anything runs) · Run-time errors (what catch sees) · error kinds
Library Referencea script-side call: builtin methods, the library namespaces, and the lookup tables for formatting, binary data, regular expressions, JSON, reflection, the web client and random numbersBuiltin methods · Arrays (35) · Maps (14) · Strings (56: 38 reading, 18 in place) · Smart pointers · Formatting: format specs · JSON and key order · Binary data · Regular expressions · Location builtins · Reflection calls · Web functions and the HTTP client · Random generator algorithm · ANSI escape sequences · Library at a glance · a bare engine
Host and Runner Referencea C++-side call or a runner flag: the engine API by task, the embedding chapters' tables, the command-line runner, performance rules of thumb, the repository's documentsEngine API quick reference · Engine lifecycle & execution · Registering the host surface · Safety rails · Time source · Static checking & precompiled scripts · Serialization & coroutines · Thread pool · dynamic_binder · Safety rails · Static checking · Hot reload · Serialization archives · Signal threading policies · Language server · More host calls · jai_spider · Command-line runner · The runner's host API · Performance rules of thumb · Documents · runner builtins · Ctrl+C
Full API Signaturesone signature: arguments, defaults, result, effects and availability of every builtin, library function and runner function

Conventions​

  • A handle is a shared_ptr<T>; a reference is a T&.
  • The checker is the static checker that runs before any script executes. It is always strict; a [[warn_mode]] region is the opt-out (attributes).
  • A load error is one the checker or the parser reports before anything runs; a run-time error is one catch sees (which is which).
  • A rule that needs more than a row links to the guide section that shows it running.