Trigger

Type alias exported by @botmesh/core.

type Trigger = 
  | string
  | RegExp
  | (string | RegExp)[]
  | TriggerObject
  | ((ctx) => boolean)
  | TypeTrigger
  | WelcomeTrigger;

Defined in: core/types.ts:476

What bot.when() and flow() match: a text (normalized equality), a RegExp (tested against the raw body), a list of them, a TriggerObject, a predicate, a type trigger (IMAGE, CALL…) or WELCOME.

Union Members

string

---

RegExp

---

(string | RegExp)[]

---

TriggerObject

---

Function

(ctx) => boolean

---

TypeTrigger

IMAGE, MEDIA, CALL, … or typeTrigger(...) — see core/triggers.ts.

---

WelcomeTrigger

The first-contact WELCOME trigger — see core/triggers.ts.

Example

bot.when('menu', showMenu) // "Menu" and "MENÚ " match too
bot.when(/^order\s+\d+$/i, showOrder)
bot.when(['hi', 'hello'], greet)
bot.when(IMAGE, (ctx) => ctx.reply('Nice picture!'))