KMsgConfig

Defined in: packages/messaging/src/k-msg.ts:155

Configuration object for initializing a KMsg instance.

Example

const config: KMsgConfig = {
  providers: [
    new SolapiProvider({
      apiKey: process.env.SOLAPI_API_KEY!,
      apiSecret: process.env.SOLAPI_API_SECRET!,
      defaultFrom: '01000000000',
    }),
  ],
  routing: {
    defaultProviderId: 'solapi',
  },
  defaults: {
    sms: { autoLmsBytes: 90 },
  },
};

Properties

defaults?

optional defaults?: KMsgDefaultsConfig

Defined in: packages/messaging/src/k-msg.ts:170

Optional defaults applied to outgoing messages.

---

hooks?

optional hooks?: KMsgHooks

Defined in: packages/messaging/src/k-msg.ts:176

Optional lifecycle hooks for send operations. Hooks are called at various stages: before send, on success, on error, and on completion.

---

persistence?

optional persistence?: object

Defined in: packages/messaging/src/k-msg.ts:185

Optional persistence configuration for message storage.

• none: No persistence (default)
• log: Fire-and-forget async logging
• queue: Queue for async processing
• full: Full persistence with status updates

repo

repo: MessageRepository

strategy

strategy: PersistenceStrategy

---

providers

providers: Provider[]

Defined in: packages/messaging/src/k-msg.ts:160

Array of provider instances to use for sending messages. At least one provider is required.

---

routing?

optional routing?: KMsgRoutingConfig

Defined in: packages/messaging/src/k-msg.ts:165

Optional routing configuration for provider selection.