Skip to main content

Type Alias: WhatsAppAwareMessagingUtils

WhatsAppAwareMessagingUtils = MessagingUtils & object

Defined in: auth/src/auth/shared.ts:248

A MessagingUtils that may additionally report whether WhatsApp delivery is currently usable. A subclass whose WhatsApp settings can change at runtime (e.g. because they live in a database rather than in the static config) implements isWhatsAppConfigured() so the OTP routes always see its current state.

Type Declaration​

isWhatsAppConfigured()?​

optional isWhatsAppConfigured(): boolean | Promise<boolean>

Returns true while a one-time code can currently be sent over WhatsApp. Optional - see isWhatsAppConfigured() for what is consulted when it isn't implemented.

Returns​

boolean | Promise<boolean>