@wpkernel/core v0.12.1-beta.3

---

@wpkernel/core / ActionJobs

Type Alias: ActionJobs

type ActionJobs = object;

Background job orchestration interface for asynchronous work.

Actions use this interface to schedule and wait for background jobs (email sending, data processing, webhook delivery). The actual job execution is handled by the runtime job engine provided by the host application.

Example

async function SendWelcomeEmail(ctx, { userId }) {
  // Enqueue background job
  await ctx.jobs.enqueue('email.send', {
    to: user.email,
    template: 'welcome',
    userId
  });

  // Or wait for job completion
  const result = await ctx.jobs.wait('email.send', payload, {
    timeoutMs: 30000,
    pollIntervalMs: 1000
  });
}

Properties

enqueue()

enqueue: <TPayload>(jobName, payload) => Promise<void>;

Type Parameters

TPayload

TPayload

Parameters

jobName

string

payload

TPayload

Returns

Promise<void>

---

wait()

wait: <TPayload, TResult>(jobName, payload, options?) => Promise<TResult>;

Type Parameters

TPayload

TPayload

TResult

TResult

Parameters

jobName

string

payload

TPayload

options?

WaitOptions

Returns

Promise<TResult>