Skip to content

@lubusin/wp-frappe-data-store / useFrappeResourceList

Function: useFrappeResourceList()

useFrappeResourceList(store, doctype, query?): object & RequestStatus

Defined in: src/hooks.ts:50

React hook to subscribe to a queried list of Frappe documents. Automatically triggers background fetching via store resolvers if not already cached.

Parameters

store

FrappeDataStore

The registered Frappe @wordpress/data store descriptor.

doctype

string

The Frappe DocType name (e.g., 'Task').

query?

FrappeListQuery = {}

Optional query parameters (filters, order by, limit, fields).

Returns

object & RequestStatus

Object containing matching resources array, isResolving loading state, and any request error.

Released under the MIT License.