.subscribeLive()

Registers a callback function for a running live query.

Method Syntax
db.subscribeLive<T>(queryUuid, callback)

Arguments

Example usage

await db.subscribeLive(
	queryUuid,
	// The callback function takes an object with the "action" and "result" properties
	( action, result ) => {
		// action can be: "CREATE", "UPDATE", "DELETE" or "CLOSE"
	    if (action === 'CLOSE') return;

		// result contains either the entire record, or a set of JSON patches when diff mode is enabled
		processSomeLiveQueryUpdate(result);
	}
)

Live Actions

For CREATE, UPDATE and DELETE, the type Result is the generic argument passed to .live() or .subscribeLive().
It extends either Record<string, unknown> or Patch.

It’s generally recommended to handle the CLOSE action first, as that clears out the type for the result parameter.