ReadOptions
Options shared by the two content-reading endpoints.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”
optionalctx?:ContextBag
The personalization context. Present = server-resolve (personalization collapsed, tokens injected); absent = client-resolve (unresolved variant-set envelopes come back).
locale?
Section titled “locale?”
optionallocale?:string
One locale code. The server resolves its fallback chain; the high-level client picks the code.
optionalraw?:boolean
Keep Localizable envelopes unresolved. Never sent by the high-level client.
referencePaths?
Section titled “referencePaths?”
optionalreferencePaths?:boolean
Attach every reference descriptor’s own published address(es) — wire include=referencePaths.
The paths member is the same one listComponents({ paths: true }) puts on an item, with the
same rules, but on the references inside a document: a post’s series, a parent article, a
related-reading list. [] means the target is bound at no live node; the member being absent
means this option was not sent.
Present at any depth and whether or not the descriptor was expanded, so a resolve: 0 read is
enough to build navigation. Pick one with pathForSite.
resolve?
Section titled “resolve?”
optionalresolve?:number
Expansion depth (an integer, capped at 10 server-side). Omitted = 0, descriptors only.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal