WorkCalendar

Business calendar

Hierarchy

  • BaseWorkCalendar
    • WorkCalendar

Properties

Readonly default

default: boolean

Attribute showing that the calendar is being used as the default calendar.

Optional description

description: undefined | string

Description.

Optional Readonly id

id: undefined | string

Unique identifier (uuid).

name

name: string

Name.

Methods

delete

  • delete(): Promise<void>

  • Deletes the calendar.

    Returns Promise<void>

getDays

  • getDays(from: TDate, to: TDate, startAt?: TDate): Promise<readonly Readonly<WorkCalendarDay>[]>
  • getDays(year: number, startAt?: TDate): Promise<readonly Readonly<WorkCalendarDay>[]>

  • Returns calendar days for the specified year.

    Parameters

    Returns Promise<readonly Readonly<WorkCalendarDay>[]>

  • Returns calendar days for the specified year.

    Parameters

    • year: number
    • Optional startAt: TDate

    Returns Promise<readonly Readonly<WorkCalendarDay>[]>

getSchedule

getSpecialCalendar

  • Get associated calendar of exception days.

    Returns Promise<SpecialCalendar | undefined>

resetSpecialCalendar

  • resetSpecialCalendar(): void

  • Unbind the celandar of exeption days.

    Returns void

save

  • save(): Promise<void>

  • Saves changes in the calendar.

    Returns Promise<void>

setSchedule

  • Set working schedule (cycle).

    Parameters

    Returns void

setSpecialCalendar

  • Bind a calendar of exception days.

    Parameters

    Returns void