Skip to main content

Interface: Capabilities

Defined in: packages/client/src/api/adapter.ts:55

Behavior that depends on the Frappe release rather than the REST generation (apiVersion). Every field is conservative when frappeVersion is unset: it resolves to the value that produces correct behavior on every release this client supports.

Stable​

Properties​

listExpand​

readonly listExpand: boolean

Defined in: packages/client/src/api/adapter.ts:71

frappe.client.get_list accepts expand. Confirmed present on Frappe 15 and 16, absent on Frappe 14 (unexpected kwarg). Unknown -> true (do not throw; omit frappeVersion: 14 and expand together). When false, getDocList / getDocListPage / paginate throw FeatureNotSupportedError if expand is set.

restListHonorsExtendedFilters​

readonly restListHonorsExtendedFilters: boolean

Defined in: packages/client/src/api/adapter.ts:83

The REST list endpoint (/api/resource/{doctype} on apiVersion: 1, /api/v2/document/{doctype} on apiVersion: 2) forwards to frappe.client.get_list verbatim, so orFilters / parent / expand reach the query. Confirmed true for apiVersion: 1 on every release, and for apiVersion: 2 on Frappe 15 (its document_list is frappe.call(frappe.client.get_list, ...), identical to v1). Confirmed false for apiVersion: 2 on Frappe 16 (develop's document_list is a rewritten handler that reads only fields, filters, order_by, start, limit, group_by, debug, as_dict). Unknown -> false for apiVersion: 2 (routes through the frappe.client.get_list RPC instead, which works identically on every release).

validateLinkAndFetch​

readonly validateLinkAndFetch: boolean

Defined in: packages/client/src/api/adapter.ts:64

frappe.client.validate_link_and_fetch exists. Confirmed present on Frappe 16, absent on Frappe 14/15 (validate_link was removed in Frappe 16). Unknown -> false.

When this is true, db.validateLink() routes to validate_link_and_fetch (mapping fields → fields_to_fetch). When false, validateLink() calls validate_link (Frappe 14/15). Frappe 16 sites must pass frappeVersion: 16 so validateLink does not hit the deleted RPC.