Function: isControlMessage()#

function isControlMessage<T>(message): message is ControlMessage;

Defined in: node_modules/.pnpm/@electric-sql+client@1.5.14/node_modules/@electric-sql/client/dist/index.d.ts:907

Type guard for checking Message is ControlMessage.

See TS docs for information on how to use type guards.

Type Parameters#

T#

T extends Row\<`unknown`\> = Row\<`never`\>

Parameters#

message#

Message\<`T`\>

the message to check

Returns#

message is ControlMessage

true if the message is a ControlMessage

*

Example#

if (isControlMessage(message)) {
  const msgChng: ChangeMessage = message // Err, type mismatch
  const msgCtrl: ControlMessage = message // Ok
}