Interface IZRestfulUpdate<T>

A restful service that can update resources.

interface IZRestfulUpdate<T> {
update(identification: string, fields: Partial<T>): Promise<T>;
}

Type Parameters

T
The type of resource being updated.

Hierarchy (View Summary)

IZRestfulUpdate
- IZRestfulService

Index

Methods

Methods

update

update(identification: string, fields: Partial<T>): Promise<T>
Partially updates an existing resource entity.

This uses the PATCH verb.
Parameters
- identification: string
  The identification of the resource to update.
- fields: Partial<T>
  The partial fields to update.
Returns Promise<T>
The resource that was updated.
- Defined in packages/webigail-rest/src/service/restful-update.mts:21