Skip to content

DoCurious API Reference / types / LearningPath

Interface: LearningPath

Defined in: types/learningPath.types.ts:15

Base interface for all persisted domain entities, providing a UUID and timestamps.

Remarks

Nearly every domain type in the application extends BaseEntity. The id field is mapped from the backend's uuid column by the adapter layer.

Extends

Properties

branches?

optional branches: object[]

Defined in: types/learningPath.types.ts:34

Branching points where the user can choose alternate paths

afterChallengeIndex

afterChallengeIndex: number

pathIds

pathIds: string[]


category

category: string

Defined in: types/learningPath.types.ts:24


challengeIds

challengeIds: string[]

Defined in: types/learningPath.types.ts:19


checkpoints

checkpoints: PathCheckpoint[]

Defined in: types/learningPath.types.ts:20


completionCount

completionCount: number

Defined in: types/learningPath.types.ts:27


coverImageUrl?

optional coverImageUrl: string

Defined in: types/learningPath.types.ts:18


createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt


creatorId

creatorId: string

Defined in: types/learningPath.types.ts:25


description

description: string

Defined in: types/learningPath.types.ts:17


difficulty

difficulty: DifficultyLevel

Defined in: types/learningPath.types.ts:21


enrollmentCount

enrollmentCount: number

Defined in: types/learningPath.types.ts:26


estimatedDuration

estimatedDuration: string

Defined in: types/learningPath.types.ts:22


id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id


pathBadgeId?

optional pathBadgeId: string

Defined in: types/learningPath.types.ts:28


prerequisites?

optional prerequisites: string[]

Defined in: types/learningPath.types.ts:31

Other learning path IDs that must be completed before starting this one


status

status: PathStatus

Defined in: types/learningPath.types.ts:23


title

title: string

Defined in: types/learningPath.types.ts:16


updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt

DoCurious Platform Documentation