PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / ScheduleDefinitionBuilder

Class: ScheduleDefinitionBuilder ​

Defined in: ScheduleDefinitionBuilder/ScheduleDefinitionBuilder.impl.ts:3

Constructors ​

Constructor ​

new ScheduleDefinitionBuilder(name, description): ScheduleDefinitionBuilder

Defined in: ScheduleDefinitionBuilder/ScheduleDefinitionBuilder.impl.ts:4

Parameters ​

name ​

string

description ​

string

Returns ​

ScheduleDefinitionBuilder

Methods ​

emitEvent() ​

emitEvent(eventName, options): ScheduleDefinition

Defined in: ScheduleDefinitionBuilder/ScheduleDefinitionBuilder.impl.ts:21

Mark this schedule as emitting a PURISTA custom event.

Parameters ​

eventName ​

string

options ​

ScheduleOptions

Returns ​

ScheduleDefinition

Example ​

ts
service
  .getScheduleBuilder('monthlyBillingCycle', 'Monthly billing trigger')
  .emitEvent('billing.monthlyCycleDue', {
    expression: { kind: 'cron', value: '0 2 1 * *' },
  })

enqueueQueue() ​

enqueueQueue(queueName, options): ScheduleDefinition

Defined in: ScheduleDefinitionBuilder/ScheduleDefinitionBuilder.impl.ts:28

Mark this schedule as enqueueing one durable queue job.

Parameters ​

queueName ​

string

options ​

ScheduleOptions

Returns ​

ScheduleDefinition

invokeCommand() ​

invokeCommand(commandName, options): ScheduleDefinition

Defined in: ScheduleDefinitionBuilder/ScheduleDefinitionBuilder.impl.ts:35

Mark this schedule as invoking short, idempotent command trigger logic.

Parameters ​

commandName ​

string

options ​

ScheduleOptions

Returns ​

ScheduleDefinition