isChangeMessage

function isChangeMessage<T>(message): message is ChangeMessage<T>;

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

Type guard for checking Message is ChangeMessage.

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 ChangeMessage<T>

true if the message is a ChangeMessage

Example

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