Class Entry

Hierarchy

  • Entry

Implements

  • SubjectContainer

Constructors

constructor

Properties

className date day description newRoom newSubject oldRoom oldSubject period subjectShorts type

Accessors

exactDateAndTime longNewSubject longOldSubject realTime

Methods

equals longSubjectName registerSubjectShorts toJSON fromJSON

Constructors

constructor

  • new Entry(date: string | Date, day: string, className: string[], period: number, type: string, oldSubject: string, newSubject: string, oldRoom: string, newRoom: string, description: string): Entry

  • Parameters

    • date: string | Date
    • day: string
    • className: string[]
    • period: number
    • type: string
    • oldSubject: string
    • newSubject: string
    • oldRoom: string
    • newRoom: string
    • description: string

    Returns Entry

Properties

Readonly className

className: string[]

Readonly date

date: Date

Readonly day

day: string

Readonly description

description: string

Readonly newRoom

newRoom: string

Readonly newSubject

newSubject: string

Readonly oldRoom

oldRoom: string

Readonly oldSubject

oldSubject: string

Readonly period

period: number

Readonly subjectShorts

subjectShorts: Map<string, string> = ...

Readonly type

type: string

Accessors

exactDateAndTime

  • get exactDateAndTime(): Date

  • This property returns a Date object, that represents the exact Day, month, year, hour and minute of the lesson

    Returns Date

longNewSubject

  • get longNewSubject(): string

  • The newSubject property is only the short of the subject. Here you get the full name of a subject.

    Example

    // entry.newSubject = "E"

    entry.longNewSubject
    // -> Englisch

    Returns string

longOldSubject

  • get longOldSubject(): string

  • The oldSubject property is only the short of the subject. Here you get the full name of a subject.

    Example

    // entry.oldSubject = "WI"

    entry.longOldSubject
    // -> Wirtschaft

    Returns string

realTime

  • get realTime(): Date

  • The entry only holds a period attribute, which does not represent actual time. This function gives you the real time of the lesson.

    This function assumes that the first period takes place at 07:30 and one period takes 45 minutes.

    Returns

    Real time of the lesson

    Returns Date

Methods

equals

  • check if this entry equals another entry

    Returns

    whether the entries are equal

    Parameters

    • other: Entry

      the entry to compare to this one

    Returns boolean

Private longSubjectName

  • Parameters

    • subjectShort: string

    Returns string

registerSubjectShorts

  • Update the subject shorts with a map

    Example

    entry.updateSubjectShorts(new Map([["D", "Deutsch"]]))

    Parameters

    • subjectShorts: Map<string, string>

      the subject shorts mapped to their long name

    Returns void

toJSON

Static fromJSON

  • Create a new instance from JSON

    Returns

    A new Entry instance

    Parameters

    • data: object

      The JSON data

    Returns Entry

Settings

Member Visibility

Theme

Generated using TypeDoc