API reference

Every symbol the Angular adapter adds, generated from its source. Three entry points:

Import from	What it holds
@qubeejs/angular	Providers, services, lists, adapters, tokens — and the whole of @qubeejs/core, re-exported
@qubeejs/angular/router	provideQubeeRouterAdapter(); the only entry point that needs @angular/router
@qubeejs/angular/http	qubeeHttpResource(); built on httpResource(), so it needs Angular 19.2

Not listed here

@qubeejs/angular re-exports every driver, enum, error, model, strategy and helper of @qubeejs/core — STRAPI_DRIVER, SortEnum, PaginatedCollection, defineList()… Their reference is in the core API docs ↗.

Providers

Configure the driver once, and scope fresh query state where you need it.

• buildQubeeProviders() — Build the core provider list shared by provideQubee() and QubeeModule.forRoot()
• createQubeeInstance() — Create an isolated query builder, paginator and store, wired together
• provideQubee() — Sets up providers necessary to enable Qubee functionality for the application
• provideQubeeInstance() — Providers for a component-scoped Qubee instance
• QubeeModule — NgModule entry point for applications that still bootstrap with modules

Services

The injectables: the query builder with its signals, the paginator and the store they share.

• QubeePaginator — Parses backend responses into typed PaginatedCollections and syncs the page metadata back into the shared QubeeSignalStore
• QubeeQueryBuilder — The query builder, as an Angular service
• QubeeSignalStore — The query-builder state container, made reactive for Angular

Lists

Lists whose state lives in the URL, and the adapters that read and write it.

• createQubeeMemoryAdapter() — Create an adapter that keeps a list’s query in memory, out of the address bar
• injectQubeeList() — A list’s state as a reactive handle, read from the URL and written back to it
• provideQubeeBrowserAdapter() — Provide an adapter that reads and writes the address bar through the History API, for an application without the Angular Router
• provideQubeeMemoryAdapter() — Provide a memory adapter to every list under an injector
• provideQubeeRouterAdapter() — Provide an adapter that reads and writes the URL through the Angular Router

Fetching

Fetching a list page with httpResource(), from @qubeejs/angular/http.

• qubeeHttpResource() — Fetch the page a list request asks for, and fetch again when it changes
• QubeeHttpResourceOptions — Options of qubeeHttpResource
• QubeeHttpResourceRef — What qubeeHttpResource returns

Tokens

What provideQubee() registers, for when you need to read or replace one.

• QUBEE_BASE_URL — Injection token for the base URL every generated URI starts with
• QUBEE_DRIVER — Injection token for the active driver definition
• QUBEE_LIST_ADAPTER — Injection token for the adapter injectQubeeList() reads and writes the URL through
• QUBEE_REQUEST_OPTIONS — Injection token for the resolved request query-parameter key options
• QUBEE_REQUEST_STRATEGY — Injection token for the resolved request URI strategy
• QUBEE_RESPONSE_OPTIONS — Injection token for the resolved response field-key options
• QUBEE_RESPONSE_STRATEGY — Injection token for the resolved response parsing strategy

Errors

What the adapter throws on its own.

• MissingRouterAdapterError — Thrown by injectQubeeList() when no adapter is passed and none is provided under QUBEE_LIST_ADAPTER

Types

The types of the adapter’s own API.

• QubeeInstance — What createQubeeInstance() returns: the three Angular objects, already wired together around one private store
• QubeeList — What injectQubeeList() returns for a list definition TList
• QubeeListAdapter — Where a list reads its URL from and how it writes one back
• QubeeListArgs — The arguments injectQubeeList() takes after the list
• QubeeListInput — The input a list declares, as injectQubeeList() takes it: the value, a signal or function returning it, or null for “not ready yet”
• QubeeListNavigateOptions — How a list asks its adapter to navigate
• QubeeListOptions — Options of injectQubeeList() common to every list
• QubeeListRequest — The value of a QubeeList’s request: a ListRequest for a list without an input, and ListRequest | null for a list that declares one — null while its input is null
• QubeeListSetOptions — Options of set() and toggleSort() on a QubeeList
• QubeeListSortToggle — The toggleSort member of a QubeeList: present only when the list declares exactly one sortParam, with field typed to the fields it allows