Skip to main content

CronDefinition

@webda/core

Class: CronDefinition

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

Cron item

Constructors​

Constructor​

new CronDefinition(cron, input?, serviceName?, method?, description?, operationId?): CronDefinition

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

Create a new CronDefinition instance

Parameters​

cron​

string

the cron expression

input?​

Record<string, any> = {}

the operation input

serviceName?​

string = ""

the service name

method?​

string = ""

the service method

description?​

string = ""

the description

operationId?​

string = ""

the operation called

Returns​

CronDefinition

Properties​

cron​

cron: string

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

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:45

Description of the task

input​

input: Record<string, any>

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

Input of the operation, validated against its input schema

method​

method: string

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

Method to call

operationId​

operationId: string

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

Operation called at each tick

serviceName​

serviceName: string

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

Webda service name

Methods​

toString()​

toString(): string

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

Format the cron definition as a human-readable string

Returns​

string

the result