afterUpdate( )
A hook that is triggered after an update()
operation.
Description
The afterUpdate()
hook runs when:
- The
update()
function is called. - An action is performed on a dataset that updates an item from the collection.
- An item is updated using the Content Manager.
Return an object or a Promise that resolves to an object from the afterUpdate()
function. The returned object will be used as the result of the call to the
update()
function instead of the actual item updated
in the collection. If returning a Promise, the object is used as the result,
whether the Promise is fulfilled or rejected.
If the returned value is of the wrong type, the value is ignored.
A rejected Promise also calls the onFailure()
hook if it has
been registered.
Because the afterUpdate
hook is called after the update()
is executed, it cannot affect the item that is being updated in the collection.
It can only affect the item returned by update()
.
Authorization
Request
This endpoint does not take any parameters
Response Object
The item to return to update()
instead of the updated item.
Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the onFailure()
hook.
Returns an empty object.
Status/Error Codes
Was this helpful?
1// In data.js23export function myCollection_afterUpdate(item, context) {4 let hookContext = context; // see below56 // some changes to the received item78 return item;9}1011/*12 * hookContext:13 *14 * {15 * "collectionName": "myCollection",16 * "userId": "f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3",17 * "userRole": "siteOwner"18 * }19 */
update()
using an afterUpdate hook1// In data.js23export function myCollection_afterUpdate(item, context) {4 let hookContext = context; // see below56 // add a full_name property to the item being returned7 item.full_name = item.first_name + " " + item.last_name;89 return item;10}1112/*13 * hookContext:14 *15 * {16 * "collectionName": "myCollection",17 * "userId": "f45jf8d2-grkj-2opd-4ovk-9rfj4wo5tvj3",18 * "userRole": "siteOwner"19 * }20 */