GetComponentOptions
@ebitex/content-sdk — the framework-agnostic half.
- Low-level:
createDeliveryClient— one method per Content Delivery API endpoint, the delivered vocabulary as types (types.ts) and runtime guards (guards.ts), typed errors. - High-level:
createContentClient—resolveLocation(location)for router changes: site from the page’s own host, locale from the browser’s languages against the organization’s tree, the context bag, afull/normalizedresolve strategy, caching and cancellation.
Nothing here imports React; the rendering layer is @ebitex/content-sdk/react. Both clients
run in a browser (with a browser-safe delivery key) and in Node (any key).
Extends
Section titled “Extends”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).
Inherited from
Section titled “Inherited from”locale?
Section titled “locale?”
optionallocale?:string
One locale code. The server resolves its fallback chain; the high-level client picks the code.
Inherited from
Section titled “Inherited from”paths?
Section titled “paths?”
optionalpaths?:boolean
Attach this component’s own published address(es) — wire include=paths, the same value
listComponents({ paths: true }) reports for the same key. Distinct from referencePaths,
which is about the pages this component’s document names.
optionalraw?:boolean
Keep Localizable envelopes unresolved. Never sent by the high-level client.
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”resolve?
Section titled “resolve?”
optionalresolve?:number
Expansion depth (an integer, capped at 10 server-side). Omitted = 0, descriptors only.
Inherited from
Section titled “Inherited from”signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Inherited from
Section titled “Inherited from”
optionalsite?:string