Type alias Topic

Topic: {
    convertibleTo?: readonly string[];
    datatype: string;
    name: string;
    schemaName: string;
}

A topic is a namespace for specific types of messages

Type declaration

  • Optional convertibleTo?: readonly string[]

    Lists any additional schema names available for subscribers on the topic. When subscribing to a topic, the panel can request messages be automatically converted from schemaName into one of the convertibleTo schemas using the convertTo option.

  • datatype: string

    Deprecated

    Renamed to schemaName. datatype will be removed in a future release.

  • name: string

    topic name i.e. "/some/topic"

  • schemaName: string

    The schema name is an identifier for the types of messages on this topic. Typically this is the fully-qualified name of the message schema. The fully-qualified name depends on the data source and data loaded by the data source.

    i.e. package.Message in protobuf-like serialization or pkg/Msg in ROS systems.