Function startAndListenGeneration

  • startAndListenGeneration(...p): EventfulPromise<ReportResult, GenerationEvents>

  • Start generation of a report and track progress

    Needs namespaces[namespaceId].tasks-post-task-run & namespaces[namespaceId].queues-get-queue-jobs-jobId permissions

    Parameters

    • Rest ...p: [taskOrId: string | RawFullTask, params?: {
          period?: Period;
          testEmails?: string[];
      }, namespaces?: string[]]

    Returns EventfulPromise<ReportResult, GenerationEvents>

    When generation ends, with detail

    Fires

    #started When generation started. See GenerationStartedEvent.

    Fires

    #progress When generation progress. See GenerationProgressEvent. Job's progress is between 0 and 1

    Throws

    If job's fails. Not if generation fails !

Settings

Member Visibility

Theme

Generated using TypeDoc