From ba44652457cd3c0eeacb92fac2df9720a6ffb396 Mon Sep 17 00:00:00 2001 From: Matt Aitken Date: Wed, 5 Jul 2023 20:17:09 +0100 Subject: [PATCH] intervalTrigger() jsdocs --- .changeset/lovely-plants-brake.md | 5 +++++ packages/trigger-sdk/src/triggers/scheduled.ts | 3 +++ 2 files changed, 8 insertions(+) create mode 100644 .changeset/lovely-plants-brake.md diff --git a/.changeset/lovely-plants-brake.md b/.changeset/lovely-plants-brake.md new file mode 100644 index 000000000..61186425f --- /dev/null +++ b/.changeset/lovely-plants-brake.md @@ -0,0 +1,5 @@ +--- +"@trigger.dev/sdk": patch +--- + +intervalTrigger() jsdocs diff --git a/packages/trigger-sdk/src/triggers/scheduled.ts b/packages/trigger-sdk/src/triggers/scheduled.ts index a06b43ac8..8dd213baf 100644 --- a/packages/trigger-sdk/src/triggers/scheduled.ts +++ b/packages/trigger-sdk/src/triggers/scheduled.ts @@ -68,6 +68,9 @@ export class IntervalTrigger implements Trigger { } } +/** `intervalTrigger()` is set as a [Job's trigger](/sdk/job) to trigger a Job at a recurring interval. + * @param options An object containing options about the interval. + */ export function intervalTrigger(options: IntervalOptions) { return new IntervalTrigger(options); }