Background
QueryBuilder exposes raw() and explain() to inspect the compiled APICalypse body. This is helpful when users are learning how typed builder calls map to IGDB syntax.
Proposed change
Add a compact recipe that builds a typed query, shows the expected compiled output, and explains when to use raw() versus explain().
Acceptance criteria
- Uses supported builder methods such as
.select(), .where(), .sort(), and .limit().
- Shows the generated APICalypse body in a code block.
- Mentions that
explain() logs and returns the builder for continued chaining.
- Does not add runtime behavior.
Files likely involved
docs/querying.mddocs/examples.mdsrc/query/QueryBuilder.ts
Background
QueryBuilderexposesraw()andexplain()to inspect the compiled APICalypse body. This is helpful when users are learning how typed builder calls map to IGDB syntax.Proposed change
Add a compact recipe that builds a typed query, shows the expected compiled output, and explains when to use
raw()versusexplain().Acceptance criteria
.select(),.where(),.sort(), and.limit().explain()logs and returns the builder for continued chaining.Files likely involved
docs/querying.mddocs/examples.mdsrc/query/QueryBuilder.ts