Skip to main content

Class: Topic

Defined in: Data/Models/TopicalIndex/Topic.ts:6

Topic entity from a topical index module database

Constructors​

Constructor​

new Topic(data): Topic

Defined in: Data/Models/TopicalIndex/Topic.ts:14

Parameters​

data​
description?​

string

metadata?​

Metadata

name​

string

parentTopicId?​

number

sortOrder?​

number

topicId?​

number

Returns​

Topic

Properties​

description?​

optional description?: string

Defined in: Data/Models/TopicalIndex/Topic.ts:10

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/TopicalIndex/Topic.ts:12

name​

name: string

Defined in: Data/Models/TopicalIndex/Topic.ts:9

parentTopicId?​

optional parentTopicId?: number

Defined in: Data/Models/TopicalIndex/Topic.ts:8

sortOrder?​

optional sortOrder?: number

Defined in: Data/Models/TopicalIndex/Topic.ts:11

topicId?​

optional topicId?: number

Defined in: Data/Models/TopicalIndex/Topic.ts:7

Methods​

getDescriptionExcerpt()​

getDescriptionExcerpt(maxLength?): string

Defined in: Data/Models/TopicalIndex/Topic.ts:40

Get a description excerpt

Parameters​

maxLength?​

number = 100

Returns​

string

isRoot()​

isRoot(): boolean

Defined in: Data/Models/TopicalIndex/Topic.ts:33

Check if this is a root-level topic (no parent)

Returns​

boolean