nyx Typedoc
    Preparing search index...

    Interface ScheduleRepository

    An object responsible for storing schedules.

    interface ScheduleRepository {
        size: number;
        "[iterator]"(): IterableIterator<[Identifier, Schedule], any, any>;
        addSchedule(schedule: Schedule): Awaitable<ScheduleRepository>;
        entries(): IterableIterator<[Identifier, Schedule]>;
        getScheduleByClass(
            ScheduleClass: ClassImplements<Schedule>,
        ): Schedule | null;
        getScheduleByID(id: Identifier): Schedule | null;
        getSchedules(): ReadonlyCollection<Identifier, Schedule>;
        has(id: Identifier): boolean;
        keys(): IterableIterator<Identifier>;
        next(
            ...__namedParameters: [] | [any],
        ): IteratorResult<[Identifier, Schedule], any>;
        onStart(): Awaitable<void>;
        onStop(): Awaitable<void>;
        removeSchedule(
            scheduleOrId: Identifier | Schedule,
        ): Awaitable<ScheduleRepository>;
        return?(value?: any): IteratorResult<[Identifier, Schedule], any>;
        throw?(e?: any): IteratorResult<[Identifier, Schedule], any>;
        values(): IterableIterator<Schedule>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    size: number

    Returns the number of stored schedules.

    • Returns IterableIterator<[Identifier, Schedule], any, any>

    • Parameters

      • ...__namedParameters: [] | [any]

      Returns IteratorResult<[Identifier, Schedule], any>

    • Parameters

      • Optionalvalue: any

      Returns IteratorResult<[Identifier, Schedule], any>

    • Parameters

      • Optionale: any

      Returns IteratorResult<[Identifier, Schedule], any>