KMsg
Defined in: packages/messaging/src/k-msg.ts:76
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KMsg(
config):KMsg
Defined in: packages/messaging/src/k-msg.ts:88
Parameters
Section titled “Parameters”config
Section titled “config”KMsgConfig
Returns
Section titled “Returns”KMsg
Methods
Section titled “Methods”healthCheck()
Section titled “healthCheck()”healthCheck():
Promise<{healthy:boolean;issues:string[];providers:Record<string,ProviderHealthStatus>; }>
Defined in: packages/messaging/src/k-msg.ts:115
Returns
Section titled “Returns”Promise<{ healthy: boolean; issues: string[]; providers: Record<string, ProviderHealthStatus>; }>
send()
Section titled “send()”Call Signature
Section titled “Call Signature”send(
input):Promise<Result<SendResult,KMsgError>>
Defined in: packages/messaging/src/k-msg.ts:150
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Call Signature
Section titled “Call Signature”send(
input):Promise<BatchSendResult>
Defined in: packages/messaging/src/k-msg.ts:151
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<BatchSendResult>
sendOrThrow()
Section titled “sendOrThrow()”sendOrThrow(
input):Promise<SendResult>
Defined in: packages/messaging/src/k-msg.ts:162
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SendResult>