Circle V2 API Docs
    Preparing search index...

    Class Jobbable<TParams, TResult>Abstract

    Type Parameters

    • TParams extends Record<string, unknown>
    • TResult = unknown

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    config: JobConfig
    serviceName: string

    Stable, human-readable name for the service. Must be set explicitly on each subclass because this.constructor.name gets mangled by minification in production builds, which breaks tracing/observability span names.

    Accessors

    • get name(): string

      Returns string

    Methods

    • Parameters

      Returns string

    • Extract an entityId from params for job_executions tracking. Override in subclasses when applicable.

      Parameters

      Returns EntityId | undefined

    • Derive a deduplication key from the params. Return null to skip deduplication (every call enqueues).

      Parameters

      Returns string | null

    • Enqueue this job for async processing via Vercel Queues. Checks for deduplication via job_executions before sending.

      Parameters

      Returns Promise<SendResult>

    • Run the job with status tracking. Used by the queue handler. Errors propagate (not caught by safe()) so the RetryHandler can decide.

      Parameters

      • params: TParams
      • metadata: MessageMetadata

      Returns Promise<void>

    • Optional hook for subclasses to attach extra non-PII span attributes derived from params. The returned attributes appear on the service.${serviceName} span (and, for jobs, on job.enqueue.* and job.run.* spans too).

      Safe ID-like keys on params (e.g. patientId, templateIds, limit, cursor) are already auto-extracted via toSpanAttributes("service.input", params) — you don't need to enumerate them here. Use this hook for derived/computed attributes (counts, flags, computed names) or for fields you've explicitly verified safe but that aren't in the global allowlist. Hook output overrides auto-extracted attributes on key collision.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII. Never include emails, names, dob, free-text, etc.

      Parameters

      Returns Attributes

    • Optional hook for subclasses to attach extra non-PII span attributes derived from the successful service result. Only called when run resolves successfully; on error, the span is marked via markSpanError instead.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII (e.g. counts, status flags, computed summaries). Never include emails, names, dob, free-text, etc.

      Parameters

      Returns Attributes

    • Parameters

      • params: unknown

      Returns params is TParams