Skip to main content

CronService

@webda/core

Class: CronService

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

Webda Modda​

Extends​

Constructors​

Constructor​

new CronService(name, params): CronService

Defined in: packages/core/src/services/service.ts:192

Service

Parameters​

name​

string

The name of the service

params​

ServiceParameters

The parameters block define in the configuration file

Returns​

CronService

Inherited from​

Service.constructor

Properties​

_compiledCapabilities​

protected _compiledCapabilities: Record<string, any> = {}

Defined in: packages/core/src/services/iservice.ts:58

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See​

getCapabilities

Inherited from​

Service._compiledCapabilities

[WEBDA_EVENTS]​

[WEBDA_EVENTS]: object

Defined in: packages/core/src/services/service.ts:166

Set the Webda events here

Inherited from​

Service.[WEBDA_EVENTS]

crons​

crons: object[] = []

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

args?​

optional args?: any[]

cb?​

optional cb?: () => void

Returns​

void

context?​

optional context?: string

cron​

cron: string

description?​

optional description?: string

method?​

optional method?: string

serviceName?​

optional serviceName?: string

crontabSchedule​

crontabSchedule: (expression, func, options?) => ScheduledTask = schedule

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

Parameters​

expression​

string

func​

string | TaskFn

options?​

TaskOptions

Returns​

ScheduledTask

enable​

enable: boolean

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

logger​

protected logger: Logger

Defined in: packages/core/src/services/service.ts:179

Logger with class context

Inherited from​

Service.logger

metrics?​

protected optional metrics?: object

Defined in: packages/core/src/services/service.ts:183

Get metrics

Inherited from​

Service.metrics

name​

readonly name: string

Defined in: packages/core/src/services/iservice.ts:35

Inherited from​

Service.name

parameters​

readonly parameters: ServiceParameters

Defined in: packages/core/src/services/iservice.ts:36

Inherited from​

Service.parameters

createConfiguration?​

static optional createConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:41

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

Service.createConfiguration

filterConfiguration?​

static optional filterConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:46

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

Service.filterConfiguration

Parameters​

static Parameters: typeof ServiceParameters = ServiceParameters

Defined in: packages/core/src/services/service.ts:162

Service parameters

Inherited from​

Service.Parameters

Methods​

__clean()​

abstract __clean(): Promise<void>

Defined in: packages/core/src/services/service.ts:492

Clean the service data, can only be used in test mode

Returns​

Promise<void>

Inherited from​

Service.__clean

addAnnotations()​

addAnnotations(): void

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

Scan all services for cron annotations and add them to the schedule (once)

Returns​

void

addListener()​

addListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:83

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Inherited from​

Service.addListener

addRoute()​

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/src/services/service.ts:384

Add a route dynamicaly

Parameters​

url​

string

of the route can contains dynamic part like {uuid}

methods​

HttpMethodType[]

the HTTP methods

executer​

Function

Method to execute for this route

openapi?​

OpenAPIWebdaDefinition = {}

the OpenAPI specification

override?​

boolean = false

whether to override existing

Returns​

void

Inherited from​

Service.addRoute

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/src/services/service.ts:337

Authorize a public event subscription

Parameters​

_event​

string

the event name

_context​

OperationContext

the execution context

Returns​

boolean

true if the condition is met

Inherited from​

Service.authorizeClientEvent

computeParameters()​

computeParameters(): void

Defined in: packages/core/src/services/service.ts:201

Used to compute or derivate input parameter to attribute

Returns​

void

Deprecated​

Inherited from​

Service.computeParameters

emit()​

emit<Key>(event, data): Promise<void>

Defined in: packages/core/src/services/service.ts:473

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters​

Key​

Key extends never

Parameters​

event​

Key

the event name

data​

object[Key]

the data to process

Returns​

Promise<void>

Inherited from​

Service.emit

getCapabilities()​

getCapabilities(): Record<string, any>

Defined in: packages/core/src/services/iservice.ts:86

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns​

Record<string, any>

the result

Webda Capability-tagged​

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from​

Service.getCapabilities

getClientEvents()​

getClientEvents(): string[]

Defined in: packages/core/src/services/service.ts:325

Return the events that an external system can subscribe to

Returns​

string[]

the list of results

Inherited from​

Service.getClientEvents

getCrontab()​

getCrontab(): object[]

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

Get all registered cron entries including annotations

Returns​

object[]

the result

getMaxListeners()​

getMaxListeners(): number

Defined in: packages/core/src/events/asynceventemitter.ts:90

Returns​

number

Inherited from​

Service.getMaxListeners

getMetric()​

getMetric<T>(type, configuration): T

Defined in: packages/core/src/services/service.ts:310

Add service name label

Type Parameters​

T​

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters​

type​

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration​

MetricConfiguration<T>

the configuration

Returns​

T

the result

Inherited from​

Service.getMetric

getName()​

getName(): string

Defined in: packages/core/src/services/service.ts:483

Get service name

Returns​

string

the result string

Inherited from​

Service.getName

getOpenApiReplacements()​

getOpenApiReplacements(): any

Defined in: packages/core/src/services/service.ts:413

Return variables for replacement in openapi

Returns​

any

the result

Inherited from​

Service.getOpenApiReplacements

getOperationId()​

getOperationId(id): string

Defined in: packages/core/src/services/service.ts:371

If undefined is returned it cancel the operation registration

Parameters​

id​

string

the identifier

Returns​

string

the result

Inherited from​

Service.getOperationId

getParameters()​

getParameters(): ServiceParameters

Defined in: packages/core/src/services/service.ts:209

Get the service parameters

Returns​

ServiceParameters

the result

Inherited from​

Service.getParameters

getService()​

getService<T>(name): ServicesMap[T]

Defined in: packages/core/src/services/service.ts:300

Get a service by name

Type Parameters​

T​

T extends keyof ServicesMap

Parameters​

name​

T

the name to use

Returns​

ServicesMap[T]

the result map

Deprecated​

Use useService, might reconsider

Inherited from​

Service.getService

getState()​

getState(): ServiceStates

Defined in: packages/core/src/services/service.ts:172

Get the current state

Returns​

ServiceStates

the result

Inherited from​

Service.getState

getUrl()​

getUrl(url, _methods): string

Defined in: packages/core/src/services/service.ts:348

Return the full path url based on parameters

Parameters​

url​

string

relative url to service

_methods​

HttpMethodType[]

in case we need filtering (like Store)

Returns​

string

absolute url or undefined if need to skip the Route

Inherited from​

Service.getUrl

init()​

abstract init(): Promise<CronService>

Defined in: packages/core/src/services/service.ts:463

Will be called after all the Services are created

Returns​

Promise<CronService>

Inherited from​

Service.init

initMetrics()​

initMetrics(): void

Defined in: packages/core/src/services/service.ts:290

Init the metrics

Returns​

void

Inherited from​

Service.initMetrics

initOperations()​

initOperations(): void

Defined in: packages/core/src/services/service.ts:420

Init the operations from

Returns​

void

Operation​

decorators on this service

Inherited from​

Service.initOperations

listeners()​

listeners(eventName): Function[]

Defined in: packages/core/src/events/asynceventemitter.ts:183

Get all listeners for an event

Parameters​

eventName​

never

the event name

Returns​

Function[]

the list of results

Inherited from​

Service.listeners

loadCapabilities()​

protected loadCapabilities(): void

Defined in: packages/core/src/services/service.ts:270

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns​

void

Example​

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See​

getCapabilities

Inherited from​

Service.loadCapabilities

log()​

log(level, ...args): void

Defined in: packages/core/src/services/service.ts:513

Parameters​

level​

WorkerLogLevel

to log

args​

...any[]

additional arguments

Returns​

void

Inherited from​

Service.log

off()​

off<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:141

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Inherited from​

Service.off

on()​

on<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:119

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

Service.on

once()​

once<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:108

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

Service.once

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/src/events/asynceventemitter.ts:150

Type Parameters​

Key​

Key extends never

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Inherited from​

Service.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:130

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Inherited from​

Service.removeListener

resolve()​

resolve(): this

Defined in: packages/core/src/services/service.ts:236

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns​

this

the result

Inherited from​

Service.resolve

run()​

run(annotations?): CancelablePromise

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

Schedule and start all registered cron jobs

Parameters​

annotations?​

boolean = true

the annotations

Returns​

CancelablePromise

the result

runCron()​

runCron(id): Promise<void>

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

Run once the

Parameters​

id​

string

the cron id, as computed by CronService.getExportId

Returns​

Promise<void>

Cron-annotated​

method matching an exported cron id

Only methods declared with @Cron can be run, with their declared arguments

schedule()​

schedule(cron, cb, description?): void

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

Register a cron expression to execute a callback, buffering if not yet enabled

Parameters​

cron​

string

the cron expression

cb​

() => any

the callback function

description?​

string = ""

the description

Returns​

void

setMaxListeners()​

setMaxListeners(n): this

Defined in: packages/core/src/events/asynceventemitter.ts:97

Parameters​

n​

number

Returns​

this

Inherited from​

Service.setMaxListeners

stop()​

stop(): Promise<void>

Defined in: packages/core/src/services/service.ts:217

Shutdown the current service if action need to be taken

Returns​

Promise<void>

Inherited from​

Service.stop

toJSON()​

toJSON(): string

Defined in: packages/core/src/services/service.ts:452

Prevent service to be serialized

Returns​

string

the result

Inherited from​

Service.toJSON

toString()​

toString(): string

Defined in: packages/core/src/services/service.ts:225

Return service representation

Returns​

string

the result

Inherited from​

Service.toString

work()​

work(annotations?): CancelablePromise

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

Start the cron worker, optionally including annotated crons

Parameters​

annotations?​

string = "true"

the annotations

Returns​

CancelablePromise

the result

Annotation()​

static Annotation(cron, description?, ...args): MethodDecorator

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

Legacy decorator factory for annotating a method with a cron schedule

Parameters​

cron​

string

the cron expression

description?​

string = ""

the description

args​

...any[]

additional arguments

Returns​

MethodDecorator

the result

getCronId()​

static getCronId(cron, name?): string

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

Generate a short hash-based identifier for a cron definition

Parameters​

cron​

CronDefinition

the cron expression

name?​

string = ""

the name to use

Returns​

string

the result

getExportId()​

static getExportId(cron): string

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

Stable identifier of a cron for exported jobs (e.g. Kubernetes CronJob)

webda cron run --id <id> resolves the cron back from this identifier

Parameters​

cron​

CronDefinition

the cron definition

Returns​

string

the 8 hex characters identifier

loadAnnotations()​

static loadAnnotations(services): CronDefinition[]

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

Collect all

Parameters​

services​

any

the services

Returns​

CronDefinition[]

the list of results

Cron-annotated​

methods from the provided services