breeze-client / BreezeSetupOptions

Interface: BreezeSetupOptions

Defined in: src/config/configure.ts:24

Options accepted by configureBreeze.

Properties

ajax?

optional ajax?: AjaxAdapterRegistration

Defined in: src/config/configure.ts:34

Deprecated

Breeze no longer needs an ajax adapter: requests go through fetch. Passing one still works. It is registered as in 2.x and used instead of config.fetch, and is handed fetch as its transport if you supply both.

---

config?

optional config?: BreezeConfig

Defined in: src/config/configure.ts:49

Configure a BreezeConfig other than the global one. Rarely needed.

---

dataService?

optional dataService?: AdapterRegistration

Defined in: src/config/configure.ts:36

Data service adapter. Defaults to DataServiceWebApiAdapter.

---

fetch?

optional fetch?: BreezeFetch

Defined in: src/config/configure.ts:43

The function Breeze makes every HTTP request with. Use it to add auth headers, retry or logging, or to route requests through a framework HTTP client. Sets config.fetch; defaults to globalThis.fetch.

---

modelLibrary?

optional modelLibrary?: AdapterRegistration

Defined in: src/config/configure.ts:26

Model library adapter. Defaults to ModelLibraryBackingStoreAdapter.

---

namingConvention?

optional namingConvention?: NamingConvention

Defined in: src/config/configure.ts:46

Sets the default NamingConvention. Defaults to NamingConvention.camelCase; use NamingConvention.none when the server already sends the names the client should use.

---

uriBuilder?

optional uriBuilder?: AdapterRegistration

Defined in: src/config/configure.ts:28

Uri builder adapter. Defaults to UriBuilderJsonAdapter.