RRule

class RRule implements QueryMethods {

constructor(options?: Partial<Options>, noCache?: boolean);

private _cacheGet;

_cache: Cache | null;

options: ParsedOptions;

origOptions: Partial<Options>;

protected _iter<M extends QueryMethodTypes>(iterResult: IterResult<M>): IterResultType<M>;

_cacheAdd(

what: CacheKeys | "all",

value: Date[] | Date | null,

args?: Partial<IterArgs>,

): void;

after(dt: Date, inc?: boolean): Date;

all(iterator?: (d: Date, len: number) => boolean): Date[];

before(dt: Date, inc?: boolean): Date;

between(

after: Date,

before: Date,

inc?: boolean,

iterator?: (d: Date, len: number) => boolean,

): Date[];

clone(): RRule;

count(): number;

isFullyConvertibleToText(): boolean;

toString(): string;

toText(

gettext?: GetText,

language?: Language,

dateFormatter?: DateFormatter,

): string;

static readonly DAILY;

static readonly FR: Weekday;

static readonly FREQUENCIES: (keyof Frequency)[];

static readonly HOURLY;

static readonly MINUTELY;

static readonly MO: Weekday;

static readonly MONTHLY;

static optionsToString: optionsToString;

static parseString: parseString;

static readonly SA: Weekday;

static readonly SECONDLY;

static readonly SU: Weekday;

static readonly TH: Weekday;

static readonly TU: Weekday;

static readonly WE: Weekday;

static readonly WEEKLY;

static readonly YEARLY;

static fromString(str: string): RRule;

static fromText(text: string, language?: Language): RRule;

static parseText(text: string, language?: Language): Partial<Options>;

}

§Implements

QueryMethods

[src]

§Constructors

new RRule(options?: Partial<Options>, noCache?: boolean)

[src]

§Properties

_cacheGet

[src]

_cache: Cache | null

[src]

options: ParsedOptions

[src]

origOptions: Partial<Options>

[src]

§Methods

_iter<M extends QueryMethodTypes>(iterResult: IterResult<M>): IterResultType<M> protected

[src]

_cacheAdd(what: CacheKeys | "all", value: Date[] | Date | null, args?: Partial<IterArgs>): void

[src]

after(dt: Date, inc?: boolean): Date

[src]

Returns the first recurrence after the given datetime instance. The inc keyword defines what happens if dt is an occurrence. With inc == True, if dt itself is an occurrence, it will be returned.

@return

Date or null

all(iterator?: (d: Date, len: number) => boolean): Date[]

[src]

@param iterator

optional function that will be called on each date that is added. It can return false to stop the iteration.

@return

Array containing all recurrences.

before(dt: Date, inc?: boolean): Date

[src]

Returns the last recurrence before the given datetime instance. The inc keyword defines what happens if dt is an occurrence. With inc == True, if dt itself is an occurrence, it will be returned.

@return

Date or null

between(after: Date, before: Date, inc?: boolean, iterator?: (d: Date, len: number) => boolean): Date[]

[src]

Returns all the occurrences of the rrule between after and before. The inc keyword defines what happens if after and/or before are themselves occurrences. With inc == True, they will be included in the list, if they are found in the recurrence set.

@return

Array

clone(): RRule

[src]

@return

a RRule instance with the same freq and options as this one (cache is not cloned)

count(): number

[src]

Returns the number of recurrences in this set. It will have go trough the whole recurrence, if this hasn't been done before.

isFullyConvertibleToText(): boolean

[src]

toString(): string