Interface SchemaOptions

Which part of a recording or dataset a schema describes.

interface SchemaOptions {
    entity_path?: string;
    max_entities?: number;
    paths_only?: boolean;
}

Properties

entity_path?: string

Only describe this entity and the entities below it, e.g. /world/robot.

max_entities?: number

How many entities to describe at most. Defaults to 100, or to 10000 with paths_only.

paths_only?: boolean

Name the entities without describing what is logged on them.