Class Event

An Event is a structure different than Course or Section that can be placed on a Schedule

It is uniquely identified by its days property

Hierarchy

Event

Implements

Hashable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Event(days: string, display: boolean | number, title?: undefined | string, description?: undefined | string, room?: undefined | string): Event

- Defined in src/models/Event.ts:27
Parameters
- days: string
- display: boolean | number
- Optional title: undefined | string
- Optional description: undefined | string
- Optional room: undefined | string
Returns Event

Properties

Readonly days

days: string

Optional Readonly description

description: undefined | string

Readonly display

display: boolean

Readonly key

key: string

Optional Readonly room

room: undefined | string

Optional Readonly title

title: undefined | string

Methods

copy

copy(): Event

- Defined in src/models/Event.ts:43
Returns Event

has

has(sec: Section): boolean

- Defined in src/models/Event.ts:68
Parameters
- sec: Section
Returns boolean

hash

hash(): number

- Defined in src/models/Event.ts:39
Returns number

toJSONShort

toJSONShort(): EventJSON

- Defined in src/models/Event.ts:59
Returns EventJSON

toTimeArray

toTimeArray(): TimeArray

- Defined in src/models/Event.ts:47
Returns TimeArray

Static fromJSONShort

fromJSONShort(obj: EventJSON): Event

- Defined in src/models/Event.ts:23
Parameters
- obj: EventJSON
Returns Event

Generated using TypeDoc