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.
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[];
}
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;
}
deploymentProfile
Signature
declare const deploymentProfile: TriggerDeploymentProfile;
nativeWorkerPublication
Signature
declare const nativeWorkerPublication: (
value: Omit<TriggerWorkerPublication, "provider" | "mechanism">,
) => TriggerWorkerPublication;
index.ts
TriggerAdapter (type alias)
Signature
type TriggerAdapter<Options extends TriggerOptions = TriggerOptions> = ProviderAdapter<
typeof job,
"trigger",
ProviderConnectionValues,
ProviderBehavior<TriggerBehavior>
>;
TriggerBehavior (type alias)
Signature
type TriggerBehavior = JobsServiceBehavior;
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>>;
}
trigger
Signature
declare const trigger: <const Options extends TriggerOptions = TriggerOptions>(
options?: Options,
) => TriggerAdapter<Options>;
triggerConnectionContract
Signature
declare const triggerConnectionContract: ProviderConnectionContract;
triggerIntegration
Signature
declare const triggerIntegration: IntegrationReference<"trigger">;
triggerLocalRecipe
Signature
declare const triggerLocalRecipe: ProviderLocalRecipeReference;
index.ts
localRecipe
Signature
declare const localRecipe: Readonly<{
kind: "local-service-recipe";
protocolVersion: 2;
integrationId: "trigger";
recipeId: "trigger-docker";
recipeVersion: