Table of Contents

Interface: Topic<$Name extends string = string, $Namespace extends string = string>

Type Parameters

$Name

$Name extends string = string

$Namespace

$Namespace extends string = string

Properties

attributes

attributes: {
  Guid: string;
  ServerAssignedId?: string;
  TopicStatus: string;
  TopicType: string;
} & {
[qualifiedName: `${string}:${string}`]: string | undefined;
};

Type Declaration

Guid
Guid: string;
ServerAssignedId?
optional ServerAssignedId?: string;
TopicStatus
TopicStatus: string;
TopicType
TopicType: string;

content

content: (
  | string
  | {
  kind: "comment";
  value: string;
}
  | {
  kind: "instruction";
  target: string;
  value: string;
}
  | ReferenceLinks
  | Title
  | Priority
  | Index
  | Labels
  | CreationDate
  | CreationAuthor
  | ModifiedDate
  | ModifiedAuthor
  | DueDate
  | AssignedTo
  | Stage
  | Description
  | BimSnippet_Element
  | DocumentReferences
  | RelatedTopics
  | Comments
  | Viewpoints)[];

name

name: $Name;

namespaces?

optional namespaces?: Record<string, string>;

namespaceURI

namespaceURI: $Namespace;

prefix?

optional prefix?: string;