afterInsert( )
A hook that is triggered after an insert()
operation.
The afterInsert()
hook runs when:
- The
insert()
function is called. - An action is performed on a dataset that inserts a new item into the collection.
- An item is inserted using the CMS.
- An item is imported into the Sandbox or Live collection.
Return an object or a Promise that resolves to an object from the afterInsert()
function. The returned object will be used as the result of the call to the
insert()
function instead of the actual item inserted
into 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 afterInsert
hook is called after the insert()
is executed, it cannot affect the item that is inserted into the collection.
It can only affect the item returned by insert()
.
The item that was inserted.
Contextual information about the hook.