Skip to main content

TypeScript Quick Start

The TypeScript runtime is published on npm. The deployed generator may select an older package than npm's latest release; consult Latest Versions and first use the dependency emitted by the generated workspace.

cargo teaql services
cargo teaql evaluate --input models/
cargo teaql typescript-lib-core --input models/ --output generated/typescript-lib-core
cargo teaql typescript-app-console --input models/ --output generated/typescript-app-console

Read the generated application AGENTS.md and package manifest. Install dependencies from its lock file, then run its own build and test scripts. Do not use generated library source to discover model-specific methods. Request entity-level Assist, then field-level Assist only as needed:

cargo teaql typescript-assist-query/school --input models/
cargo teaql typescript-assist-query/school.name --input models/
cargo teaql typescript-assist-ensure-schema --input models/

For Node SQL, install the generated Runtime Module and explicitly call the context-aware module-level schema operation. Verify first and repeated root / constant seeding, a bounded Q query, loaded E expression, Checker/Fix, and an audited create/update through the generated application. Keep comment and purpose non-empty and execute using trusted context.

Browser code uses the browser-safe profile: it must not import Node SQL providers or receive database credentials. Browser federation and browser-local SQLite are separate integration paths; do not infer that a Node SQL test proves either browser path. Continue with TypeScript First Verification.