Skip to main content

CronDefinition

@webda/core

Class: CronDefinition

Defined in: packages/core/src/services/cron.service.ts:12

Cron item

Constructors​

Constructor​

new CronDefinition(cron, args?, serviceName?, method?, description?): CronDefinition

Defined in: packages/core/src/services/cron.service.ts:45

Parameters​

cron​

string

the cron expression

args?​

any[] = []

additional arguments

serviceName?​

string = ""

the service name

method?​

string = ""

the HTTP method

description?​

string = ""

the description

Returns​

CronDefinition

Properties​

args​

args: any[]

Defined in: packages/core/src/services/cron.service.ts:27

Argument to be passed to the function

cron​

cron: string

Defined in: packages/core/src/services/cron.service.ts:18

Cron definition

      • 0 3

Pattern​

^(*|([0-5]?\d)) (*|([01]?\d|2[0-3])) (*|([01]?\d|2[0-3])) (*|([0-6])) (*|([0-6]))$

description​

description: string

Defined in: packages/core/src/services/cron.service.ts:23

Description of the task

method​

method: string

Defined in: packages/core/src/services/cron.service.ts:31

Method to call

serviceName​

serviceName: string

Defined in: packages/core/src/services/cron.service.ts:35

Webda service name

Methods​

toString()​

toString(): string

Defined in: packages/core/src/services/cron.service.ts:57

Format the cron definition as a human-readable string

Returns​

string

the result