Skip to content
RelKit
Esc
↑↓navigate↵open⌘Jpreview
On this page

Labs This feature is in Labs and can change in any release.

Trigger.dev API

Generated public TypeScript reference for @relkit/trigger.

For configuration and examples, read docker, providers.

Public imports

  • @relkit/trigger — 7 exports
  • @relkit/trigger/runtime — 22 exports
  • @relkit/trigger/local-recipe — 1 exports
  • @relkit/trigger/deployment — 4 exports

All exported APIs

Names link to their complete contracts. Re-exports share their original contract; legacy exports keep their separate identity. Examples link to the API’s inline sample, a maintained repository usage, or the shared module walkthrough.

API Kind Import from Example
createTriggerHttpClient Value @relkit/trigger/runtime Module example
createTriggerRuntime Value @relkit/trigger/runtime Module example
createTriggerTask Value @relkit/trigger/runtime Module example
createTriggerTaskConfig Value @relkit/trigger/runtime Module example
createTriggerWorker Value @relkit/trigger/runtime Module example
deploymentProfile Value @relkit/trigger/deployment Module example
loadTriggerSdk Value @relkit/trigger/runtime Module example
localRecipe Value @relkit/trigger/local-recipe Module example
nativeWorkerPublication Value @relkit/trigger/deployment Module example
observeTriggerRun Value @relkit/trigger/runtime Module example
runtimeIntegration Value @relkit/trigger/runtime Module example
statusOf Value @relkit/trigger/runtime Module example
trigger Value @relkit/trigger Source example
TriggerAdapter Type @relkit/trigger Module example
TriggerBehavior Type @relkit/trigger Module example
triggerConnectionContract Value @relkit/trigger Module example
TriggerDeploymentProfile Type @relkit/trigger/deployment Module example
TriggerHttpClientOptions Type @relkit/trigger/runtime Module example
triggerIntegration Value @relkit/trigger Module example
triggerLocalRecipe Value @relkit/trigger Module example
TriggerNativeClient Type @relkit/trigger/runtime Module example
TriggerObservationOptions Type @relkit/trigger/runtime Module example
TriggerOptions Type @relkit/trigger Module example
TriggerRuntime Type @relkit/trigger/runtime Module example
TriggerRuntimeOptions Type @relkit/trigger/runtime Module example
TriggerSdk Type @relkit/trigger/runtime Module example
TriggerSdkApi Type @relkit/trigger/runtime Module example
triggerSnapshot Value @relkit/trigger/runtime Module example
TriggerSubscription Type @relkit/trigger/runtime Module example
TriggerTaskDefinition Type @relkit/trigger/runtime Module example
triggerTaskIdentifier Value @relkit/trigger/runtime Module example
TriggerWorkerHandle Type @relkit/trigger/runtime Module example
TriggerWorkerPublication Type @relkit/trigger/deployment Module example
TriggerWorkerRegistrationOptions Type @relkit/trigger/runtime Module example

index.ts

TriggerDeploymentProfile (interface)

Signature

export interface TriggerDeploymentProfile {
  readonly provider: "trigger";
  readonly compatibility: "unverified";
  readonly adapterId: "trigger";
  readonly sdk: "4.5.16";
  readonly dockerImageDigest: "sha256:3563088912cf4b880602d99815ddd787274c4ce5fc77738adf1e5bad287fbd1e";
  readonly dockerDurableSleep: false;
  readonly managedStatus: "not-tested";
  readonly scheduleVariants: readonly string[];
  readonly workerRuntime: "bun";
  readonly executionLimits: Readonly<{
    readonly inputBytes: number;
    readonly progressBytes: number;
    readonly maxRunList: number;
  }>;
  readonly policyIdentity: readonly string[];
}

Source

TriggerWorkerPublication (interface)

Signature

export interface TriggerWorkerPublication {
  readonly provider: "trigger";
  readonly mechanism: "trigger-sdk";
  readonly taskId: string;
  readonly taskVersion: string;
  readonly buildId: string;
  readonly serviceGeneration: string;
  readonly entrypoint: string;
}

Source

deploymentProfile

Signature

declare const deploymentProfile: TriggerDeploymentProfile;

Source

nativeWorkerPublication

Signature

declare const nativeWorkerPublication: (
  value: Omit<TriggerWorkerPublication, "provider" | "mechanism">,
) => TriggerWorkerPublication;

Source

index.ts

TriggerAdapter (type alias)

Signature

type TriggerAdapter<Options extends TriggerOptions = TriggerOptions> = ProviderAdapter<
  typeof job,
  "trigger",
  ProviderConnectionValues,
  ProviderBehavior<TriggerBehavior>
>;

Source

TriggerBehavior (type alias)

Signature

type TriggerBehavior = JobsServiceBehavior;

Source

TriggerOptions (interface)

Signature

export interface TriggerOptions extends JobsServiceOptions {
  readonly projectRef?: string | TextReference;
  readonly secretKey?: SecretReference;
  readonly baseUrl?: string | URL | TextReference;
  readonly native?: Readonly<Record<string, import("relkit/contracts").JsonValue>>;
}

Source

trigger

Signature

declare const trigger: <const Options extends TriggerOptions = TriggerOptions>(
  options?: Options,
) => TriggerAdapter<Options>;

Source

triggerConnectionContract

Signature

declare const triggerConnectionContract: ProviderConnectionContract;

Source

triggerIntegration

Signature

declare const triggerIntegration: IntegrationReference<"trigger">;

Source

triggerLocalRecipe

Signature

declare const triggerLocalRecipe: ProviderLocalRecipeReference;

Source

index.ts

localRecipe

Signature

declare const localRecipe: Readonly<{
  kind: "local-service-recipe";
  protocolVersion: 2;
  integrationId: "trigger";
  recipeId: "trigger-docker";
  recipeVersion: