AgendaModule

@tsed/agenda

Usage

import { AgendaModule } from "@tsed/agenda";

See /packages/third-parties/agenda/src/types/AgendaModule.ts.

Overview

class AgendaModule implements OnDestroy, AfterListen {
    protected logger: Logger;
    protected injector: InjectorService;
    protected agenda: AgendaService;
    
    $afterListen(): Promise<any>;
    $onDestroy(): Promise<any>;
    define(name: string, options?: any, processor?: any): void;
    every(interval: string, name: string, data?: any, options?: any): Promise<any>;
    schedule(when: Date | string, name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;
    now(name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;
    create(name: string, data?: any): Job<import("agenda").JobAttributesData>;
    protected getProviders(): Provider<any>[];
    protected addAgendaDefinitionsForProvider(provider: Provider): void;
    protected scheduleJobsForProvider(provider: Provider<any>): Promise<void>;
    protected getNameForJob(propertyKey: string, namespace?: string, customName?: string): string;
}

protected logger

protected logger: Logger;

protected injector

protected injector: InjectorService;

protected agenda

protected agenda: AgendaService;

$afterListen

$afterListen(): Promise<any>;

$onDestroy

$onDestroy(): Promise<any>;

define

define(name: string, options?: any, processor?: any): void;

every

every(interval: string, name: string, data?: any, options?: any): Promise<any>;

schedule

schedule(when: Date | string, name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;

now

now(name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;

create

create(name: string, data?: any): Job<import("agenda").JobAttributesData>;

protected getProviders

protected getProviders(): Provider<any>[];

protected addAgendaDefinitionsForProvider

protected addAgendaDefinitionsForProvider(provider: Provider): void;

protected scheduleJobsForProvider

protected scheduleJobsForProvider(provider: Provider<any>): Promise<void>;

protected getNameForJob

protected getNameForJob(propertyKey: string, namespace?: string, customName?: string): string;