Class KnowledgeMap<T>

Type Parameters

T = Record<string, unknown>

Index

Methods

create addTopic hasTopic getTopic removeTopic topics$ list count addPrerequisite removePrerequisite prerequisitesOf dependentsOf getMastery isUnlocked unlocked locked learningPath clear dispose

Methods

`Static`create

create<T = Record<string, unknown>>(opts?: KnowledgeMapOptions): KnowledgeMap<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- opts: KnowledgeMapOptions = {}
Returns KnowledgeMap<T>
- Defined in runtime/knowledge-map.ts:109

addTopic

addTopic(spec: TopicSpec<T>): boolean
Parameters
- spec: TopicSpec<T>
Returns boolean
- Defined in runtime/knowledge-map.ts:116

hasTopic

hasTopic(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/knowledge-map.ts:132

getTopic

getTopic(id: string): TopicState<T> | null
Parameters
- id: string
Returns TopicState<T> | null
- Defined in runtime/knowledge-map.ts:136

removeTopic

removeTopic(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/knowledge-map.ts:141

topics$

topics$(): TopicState<T>[]
Returns TopicState<T>[]
- Defined in runtime/knowledge-map.ts:164

list

list(): TopicState<T>[]
Returns TopicState<T>[]
- Defined in runtime/knowledge-map.ts:176

count

count(): number
Returns number
- Defined in runtime/knowledge-map.ts:180

addPrerequisite

addPrerequisite(
    prerequisiteId: string,
    dependentId: string,
    threshold?: number,
): boolean
Parameters
- prerequisiteId: string
- dependentId: string
- Optionalthreshold: number
Returns boolean
- Defined in runtime/knowledge-map.ts:187

removePrerequisite

removePrerequisite(prerequisiteId: string, dependentId: string): boolean
Parameters
- prerequisiteId: string
- dependentId: string
Returns boolean
- Defined in runtime/knowledge-map.ts:212

prerequisitesOf

prerequisitesOf(topicId: string): PrerequisiteEdge[]
Parameters
- topicId: string
Returns PrerequisiteEdge[]
- Defined in runtime/knowledge-map.ts:223

dependentsOf

dependentsOf(topicId: string): string[]
Parameters
- topicId: string
Returns string[]
- Defined in runtime/knowledge-map.ts:234

getMastery

getMastery(topicId: string, src: MasterySource): number
Parameters
- topicId: string
- src: MasterySource
Returns number
- Defined in runtime/knowledge-map.ts:248

isUnlocked

isUnlocked(topicId: string, src: MasterySource): boolean
Parameters
- topicId: string
- src: MasterySource
Returns boolean
- Defined in runtime/knowledge-map.ts:260

unlocked

unlocked(src: MasterySource): string[]
Parameters
- src: MasterySource
Returns string[]
- Defined in runtime/knowledge-map.ts:272

locked

locked(src: MasterySource): string[]
Parameters
- src: MasterySource
Returns string[]
- Defined in runtime/knowledge-map.ts:283

learningPath

learningPath(targetTopicId: string): string[] | null
Parameters
- targetTopicId: string
Returns string[] | null
- Defined in runtime/knowledge-map.ts:298

clear

clear(): void
Returns void
- Defined in runtime/knowledge-map.ts:327

dispose

dispose(): void
Returns void
- Defined in runtime/knowledge-map.ts:332