Skip to content

breeze-client / UriBuilderAdapter

Interface: UriBuilderAdapter ​

Defined in: src/config/interface-registry.ts:148

Builds URI for performing queries. Serializes the EntityQuery according to the URI syntax.

Extends ​

Properties ​

checkForRecomposition? ​

optional checkForRecomposition?: (context) => void

Defined in: src/config/config.ts:96

Optional. Called each time any adapter is initialized after this one first was, with { interfaceName, instance, isDefault }, so that this adapter can pick up a new dependency. The data service adapters use it to re-resolve their ajax adapter when a new default ajax adapter is initialized.

Parameters ​

context ​

any

Returns ​

void

Inherited from ​

BaseAdapter.checkForRecomposition


name ​

name: string

Defined in: src/config/config.ts:84

The name the adapter is registered under, such as 'webApi' or 'backingStore'. Names are matched without regard to case. registerAdapter reads it from a throwaway instance and throws if it is empty.

Inherited from ​

BaseAdapter.name

Methods ​

buildUri() ​

buildUri(query, metadataStore): string

Defined in: src/config/interface-registry.ts:150

Returns the URL for the query, relative to the service: its resource name followed by the query in this adapter's syntax. Breeze qualifies it with the service name, and sends the query's withParameters values separately, as request params.

Parameters ​

query ​

EntityQuery

metadataStore ​

MetadataStore

Returns ​

string


initialize() ​

initialize(): void

Defined in: src/config/config.ts:90

Called by Breeze each time the adapter is initialized: when it is first created, and again whenever it is initialized by name or registered again, for example by configureBreeze. Resolve anything the adapter depends on here, not in the constructor.

Returns ​

void

Inherited from ​

BaseAdapter.initialize

Released under the MIT License.