PulseModule

@tsed/pulse

Usage

import { PulseModule } from "@tsed/pulse";

See /packages/third-parties/pulse/src/types/PulseModule.ts.

Overview

class PulseModule implements OnDestroy, AfterListen {
    protected logger: Logger;
    protected injector: InjectorService;
    protected pulse: PulseService;
    
    $afterListen(): Promise<any>;
    $onDestroy(): Promise<any>;
    define<T extends JobAttributesData>(name: string, processor: Processor<T>, options?: DefineOptions): void;
    every(interval: string, name: string, data?: any, options?: any): Promise<Job<JobAttributesData> | Job<JobAttributesData>[]>;
    schedule(when: Date | string, name: string, data?: any): Promise<Job<{}>[]> | Promise<Job<any>>;
    now(name: string, data?: any): Promise<Job<JobAttributesData>>;
    create(name: string, data?: any): Job<any>;
    protected getProviders(): Provider<any>[];
    protected addPulseDefinitionsForProvider(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 pulse

protected pulse: PulseService;

$afterListen

$afterListen(): Promise<any>;

$onDestroy

$onDestroy(): Promise<any>;

define

define<T extends JobAttributesData>(name: string, processor: Processor<T>, options?: DefineOptions): void;

every

every(interval: string, name: string, data?: any, options?: any): Promise<Job<JobAttributesData> | Job<JobAttributesData>[]>;

schedule

schedule(when: Date | string, name: string, data?: any): Promise<Job<{}>[]> | Promise<Job<any>>;

now

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

create

create(name: string, data?: any): Job<any>;

protected getProviders

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

protected addPulseDefinitionsForProvider

protected addPulseDefinitionsForProvider(provider: Provider): void;

protected scheduleJobsForProvider

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

protected getNameForJob

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