docs(plugin): the planner door's hiddenIds contract is the answer, not the mechanism
Some checks are pending
CI / Node 22 (push) Waiting to run
CI / Node 24 (push) Waiting to run
CI / Integration + conformance (Node 22) (push) Waiting to run
CI / Bun (latest) (push) Waiting to run
Some checks are pending
CI / Node 22 (push) Waiting to run
CI / Node 24 (push) Waiting to run
CI / Integration + conformance (Node 22) (push) Waiting to run
CI / Bun (latest) (push) Waiting to run
This commit is contained in:
parent
f763317af7
commit
2633e8d5e1
1 changed files with 4 additions and 2 deletions
|
|
@ -460,8 +460,10 @@ export interface MetadataIndexProvider {
|
||||||
* @param params - The find params, already normalized by `find()`
|
* @param params - The find params, already normalized by `find()`
|
||||||
* (natural-language parsed, `connected` anchors resolved to canonical ids,
|
* (natural-language parsed, `connected` anchors resolved to canonical ids,
|
||||||
* an empty `where` dropped).
|
* an empty `where` dropped).
|
||||||
* @param hiddenIds - Ids this read must not return; apply BEFORE paging so
|
* @param hiddenIds - Ids this read must not return. The contract is the ANSWER, not the
|
||||||
* `limit` stays exact.
|
* mechanism: a provider may subtract this set before paging, or derive the
|
||||||
|
* same exclusion from the params' visibility tiers itself — either way the
|
||||||
|
* page must equal the engine's own answer with none of these ids in it.
|
||||||
* @param graphIndex - The active graph provider, for a `connected` plan.
|
* @param graphIndex - The active graph provider, for a `connected` plan.
|
||||||
* @returns The page's ids plus the stage that emptied it, or `null`.
|
* @returns The page's ids plus the stage that emptied it, or `null`.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Reference in a new issue