@usine/config/trigger

Classes

IssueTrigger

Watches issues and selects matching payloads with the Loop’s if expression.

Extends

• Schema.Class

Constructors

Constructor

new IssueTrigger(…args): IssueTrigger

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

IssueTrigger

Properties

if

readonly if: string & Brand<"ExpressionSource">

on

readonly on: "issue"

---

PullRequestTrigger

Watches pull requests and selects matching payloads with the Loop’s if expression.

Extends

• Schema.Class

Constructors

Constructor

new PullRequestTrigger(…args): PullRequestTrigger

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

PullRequestTrigger

Properties

if

readonly if: string & Brand<"ExpressionSource">

on

readonly on: "pr"

---

ScheduleTrigger

Fires per selected repository on a schedule, catching up only the latest missed Tick after downtime.

Extends

• Schema.Class

Constructors

Constructor

new ScheduleTrigger(…args): ScheduleTrigger

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ScheduleTrigger

Properties

cron

readonly cron: string & Brand<"Cron">

if

readonly if: string & Brand<"ExpressionSource">

on

readonly on: "schedule"

tz

readonly tz: string & Brand<"TimeZone">

Type Aliases

Cron

Cron = typeof Cron.Type

A five-field schedule evaluated in the trigger’s time zone.

---

Stream

Stream = Trigger["on"]

The class of state a Loop watches: issues, pull requests, or scheduled Ticks.

---

TimeZone

TimeZone = typeof TimeZone.Type

The IANA time zone whose local clock defines a schedule’s firing times.

---

Trigger

Trigger = typeof Trigger.Type

The standing Item condition or schedule that produces Events for a Loop.

Variables

Cron

const Cron: Schema.brand<Schema.String, "Cron">

A five-field schedule evaluated in the trigger’s time zone.

---

TimeZone

const TimeZone: Schema.brand<Schema.String, "TimeZone">

The IANA time zone whose local clock defines a schedule’s firing times.

---

Trigger

const Trigger: Schema.Union<readonly [typeof IssueTrigger, typeof PullRequestTrigger, typeof ScheduleTrigger]>

The standing Item condition or schedule that produces Events for a Loop.