Home > @uniformdev/canvas > CompositionDeliveryClient

CompositionDeliveryClient class

Read-only delivery client for compositions. Hits the edge host with patterns + overrides + data resources resolved and component _ids stripped — the shape sites/edge serve. Defaults state to published and bypassCache to false (cached). It has no write methods by design: you cannot read a delivery-shaped tree and PUT it back through this client.

Signature:

Extends: DeliveryClientBase

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the CompositionDeliveryClient class

Methods

Method	Modifiers	Description
get(args)		Fetches exactly one composition (throws ApiClientError(404) if absent).
list(args)		Fetches a list of compositions, optionally filtered.