@wpkernel/core / ResourceClient
Type Alias: ResourceClient<T, TQuery>
type ResourceClient<T, TQuery> = object;Client methods for REST operations
Generated automatically by defineResource based on configured routes. All methods return Promises with typed responses.
Type Parameters
T
T = unknown
The resource entity type
TQuery
TQuery = unknown
Query parameters type for list operations
Properties
create()?
optional create: (data) => Promise<T>;Create a new resource
Parameters
data
Partial<T>
Resource data to create
Returns
Promise<T>
Promise resolving to created resource
Throws
TransportError on network failure
Throws
ServerError on REST API error (including validation errors)
fetch()?
optional fetch: (id) => Promise<T>;Fetch a single resource by ID
Parameters
id
Resource identifier
string | number
Returns
Promise<T>
Promise resolving to resource entity
Throws
TransportError on network failure
Throws
ServerError on REST API error (including 404)
fetchList()?
optional fetchList: (query?) => Promise<ListResponse<T>>;Fetch a list of resources
Parameters
query?
TQuery
Query parameters (filters, pagination, etc.)
Returns
Promise<ListResponse<T>>
Promise resolving to list response
Throws
TransportError on network failure
Throws
ServerError on REST API error
remove()?
optional remove: (id) => Promise<void | T>;Delete a resource
Parameters
id
Resource identifier
string | number
Returns
Promise<void | T>
Promise resolving to void or deleted resource
Throws
TransportError on network failure
Throws
ServerError on REST API error (including 404)
ui?
optional ui: ResourceUIConfig<T, TQuery>;Optional UI metadata carried over from ResourceConfig.ui.
update()?
optional update: (id, data) => Promise<T>;Update an existing resource
Parameters
id
Resource identifier
string | number
data
Partial<T>
Partial resource data to update
Returns
Promise<T>
Promise resolving to updated resource
Throws
TransportError on network failure
Throws
ServerError on REST API error (including 404, validation errors)