Method invoke

packages/trigger-sdk/src/job.ts:202–267

(
    param1: string | TriggerInvokeType<TTrigger>,
    param2: TriggerInvokeType<TTrigger> | InvokeOptions | undefined = undefined,
    param3: InvokeOptions | undefined = undefined
  )

    options?: InvokeOptions
  ): Promise<{ id: string }>;
  async invoke(
    param1: string | TriggerInvokeType<TTrigger>,
    param2: TriggerInvokeType<TTrigger> | InvokeOptions | undefined = undefined,
    param3: InvokeOptions | undefined = undefined
  ): Promise<{ id: string }> {
    const triggerClient = this.client;

    if (!triggerClient) {
      throw new Error(
        "Cannot invoke a job that is not attached to a client. Make sure you attach the job to a client before invoking it."
      );
    }

    const runStore = runLocalStorage.getStore();

    if (typeof param1 === "string") {
      if (!runStore) {
        throw new Error(
          "Cannot invoke a job from outside of a run when passing a cacheKey. Make sure you are running the job from within a run or use the invoke method without the cacheKey."
        );
      }

      const options = param3 ?? {};

      return await runStore.io.runTask(
        param1,
        async (task) => {
          const result = await triggerClient.invokeJob(this.id, param2, {
            idempotencyKey: task.idempotencyKey,
            ...options,
          });

          task.outputProperties = [
            {
              label: "Run",
              text: result.id,
              url: `/orgs/${runStore.ctx.organization.slug}/projects/${runStore.ctx.project.slug}/jobs/${this.id}/runs/${result.id}/trigger`,
            },
          ];

          return result;
        },
        {
          name: `Manually Invoke '${this.name}'`,
          params: param2,
          properties: [
            {
              label: "Job",
              text: this.id,
              url: `/orgs/${runStore.ctx.organization.slug}/projects/${runStore.ctx.project.slug}/jobs/${this.id}`,
            },
            {
              label: "Env",
              text: runStore.ctx.environment.slug,
            },
          ],
        }
      );