Skip to content

FromOptions = object

Defined in: src/query/queryBuilder.ts:41

How a query through a schema treats a matching entity that does not fit the schema — one not tagged with a named schema’s name, or missing a selected required column or holding one of another type. Columns the selection leaves out are not checked.

optional onMismatch: "throw" | "skip"

Defined in: src/query/queryBuilder.ts:50

"skip" (the default) leaves the entity out of the page — so a page can hold fewer rows than its limit, and a page whose every entity was skipped is empty while later pages still have rows. Each page reports how many it left out as QueryResult.skipped. Arkiv is public, so anyone can write an entity that matches a query but not the schema; skipping keeps one such entity from failing every read of the others. "throw" fails the fetch with a SchemaMismatchError instead.