Skip to main content

Class: ReadingPlan

Defined in: Data/Models/User/ReadingPlan.ts:6

Reading plan entity from the user database

Constructors​

Constructor​

new ReadingPlan(data): ReadingPlan

Defined in: Data/Models/User/ReadingPlan.ts:19

Parameters​

data​
createdDate?​

string

description?​

string

durationDays?​

number

isBuiltin?​

boolean

metadata?​

Metadata

name​

string

planId?​

number

planType?​

"canonical" | "chronological" | "thematic" | "nt_only" | "ot_only" | "gospels" | "custom"

Returns​

ReadingPlan

Properties​

createdDate?​

optional createdDate?: string

Defined in: Data/Models/User/ReadingPlan.ts:13

description?​

optional description?: string

Defined in: Data/Models/User/ReadingPlan.ts:9

durationDays?​

optional durationDays?: number

Defined in: Data/Models/User/ReadingPlan.ts:11

isBuiltin​

isBuiltin: boolean

Defined in: Data/Models/User/ReadingPlan.ts:12

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/User/ReadingPlan.ts:14

name​

name: string

Defined in: Data/Models/User/ReadingPlan.ts:8

planId?​

optional planId?: number

Defined in: Data/Models/User/ReadingPlan.ts:7

planType?​

optional planType?: "canonical" | "chronological" | "thematic" | "nt_only" | "ot_only" | "gospels" | "custom"

Defined in: Data/Models/User/ReadingPlan.ts:10

Methods​

addDay()​

addDay(day): void

Defined in: Data/Models/User/ReadingPlan.ts:49

Add a day to the plan

Parameters​

day​

ReadingPlanDay

Returns​

void

getDay()​

getDay(dayNumber): ReadingPlanDay | undefined

Defined in: Data/Models/User/ReadingPlan.ts:64

Get a specific day by number

Parameters​

dayNumber​

number

Returns​

ReadingPlanDay | undefined

getDays()​

getDays(): ReadingPlanDay[]

Defined in: Data/Models/User/ReadingPlan.ts:42

Get all days in the plan

Returns​

ReadingPlanDay[]

getTotalDays()​

getTotalDays(): number

Defined in: Data/Models/User/ReadingPlan.ts:71

Get total number of days

Returns​

number

isBuiltInPlan()​

isBuiltInPlan(): boolean

Defined in: Data/Models/User/ReadingPlan.ts:78

Check if this is a built-in plan

Returns​

boolean

setDays()​

setDays(days): void

Defined in: Data/Models/User/ReadingPlan.ts:57

Set all days (from repository query)

Parameters​

days​

ReadingPlanDay[]

Returns​

void