Skip to main content

MessageSchemaDescription

type MessageSchemaDescription = object;

Describes the structure of a message with field names and their types.

Index Signature

[key: string]: 
| MessageSchemaField
| MessageSchemaDescription
| [MessageSchemaField | MessageSchemaDescription]

Example

{
// Primitive fields
position: "number",
name: "string",
active: "bool",
singleByte: "byte",

// Arrays of primitive types
coordinates: ["number"],
labels: ["string"],
flags: ["bool"],
rawData: ["byte"],

// Nested objects
metadata: {
timestamp: "number",
source: "string"
},

// Arrays of objects
points: [{
x: "number",
y: "number",
z: "number"
}]
}