API reference › @evolu/common › local‑first/Protocol › ProtocolHeader

Defined in: packages/common/src/local-first/Protocol.ts:381

The routing prefix of a ProtocolMessage.

The version and the OwnerId begin every message of every protocol version. The message type follows them only in messages of this peer's version; the layout after the prefix is unknown for any other version.

Extends

• Typed<"ProtocolHeader">

Properties

messageType?

readonly optional messageType?: MessageType;

Defined in: packages/common/src/local-first/Protocol.ts:385

Absent when version differs from protocolVersion.

ownerId

readonly ownerId: string & Brand<"Id"> & Brand<"OwnerId">;

Defined in: packages/common/src/local-first/Protocol.ts:383

type

readonly type: "ProtocolHeader";

Defined in: packages/common/src/Type.ts:15402

Inherited from

Typed.type

version

readonly version: number & Brand<"NonNaN"> & Brand<"Finite"> & Brand<"Int"> & Brand<"NonNegative">;

Defined in: packages/common/src/local-first/Protocol.ts:382