Skip to main content

Background Job

The $next module lets you invoke another function by name, optionally after a delay (in seconds).


Import / Usage

const { AppnestFunctions } = require('appnest-app-sdk-utils');
const { $next } = AppnestFunctions;

API

run

MethodSignatureDescription
run$next.run({ functionName, functionPayload, delay })Invoke a function by name. Optionally delay execution.

Parameters:

ParameterTypeRequiredDefaultDescription
functionNamestringyesTarget function name to run.
functionPayloadobjectyesData passed to the function.
delaynumberno0Delay in seconds before execution (>= 0).

Return: Promise<object> — the API response body directly (e.g. { success: boolean }). No { data, status } wrapper.


Examples

Run immediately:

await $next.run({
functionName: 'syncContacts',
functionPayload: { accountId: 12345 }
});

Run after delay (e.g. 10 seconds):

await $next.run({
functionName: 'syncContacts',
functionPayload: { accountId: 12345 },
delay: 10
});