UNPKG

2.92 kBTypeScriptView Raw
1import { NgbDate } from './ngb-date';
2import * as i0 from "@angular/core";
3export declare function fromJSDate(jsDate: Date): NgbDate;
4export declare function toJSDate(date: NgbDate): Date;
5export type NgbPeriod = 'y' | 'm' | 'd';
6export declare function NGB_DATEPICKER_CALENDAR_FACTORY(): NgbCalendarGregorian;
7/**
8 * A service that represents the calendar used by the datepicker.
9 *
10 * The default implementation uses the Gregorian calendar. You can inject it in your own
11 * implementations if necessary to simplify `NgbDate` calculations.
12 */
13export declare abstract class NgbCalendar {
14 /**
15 * Returns the number of days per week.
16 */
17 abstract getDaysPerWeek(): number;
18 /**
19 * Returns an array of months per year.
20 *
21 * With default calendar we use ISO 8601 and return [1, 2, ..., 12];
22 */
23 abstract getMonths(year?: number): number[];
24 /**
25 * Returns the number of weeks per month.
26 */
27 abstract getWeeksPerMonth(): number;
28 /**
29 * Returns the weekday number for a given day.
30 *
31 * With the default calendar we use ISO 8601: 'weekday' is 1=Mon ... 7=Sun
32 */
33 abstract getWeekday(date: NgbDate): number;
34 /**
35 * Adds a number of years, months or days to a given date.
36 *
37 * * `period` can be `y`, `m` or `d` and defaults to day.
38 * * `number` defaults to 1.
39 *
40 * Always returns a new date.
41 */
42 abstract getNext(date: NgbDate, period?: NgbPeriod, number?: number): NgbDate;
43 /**
44 * Subtracts a number of years, months or days from a given date.
45 *
46 * * `period` can be `y`, `m` or `d` and defaults to day.
47 * * `number` defaults to 1.
48 *
49 * Always returns a new date.
50 */
51 abstract getPrev(date: NgbDate, period?: NgbPeriod, number?: number): NgbDate;
52 /**
53 * Returns the week number for a given week.
54 */
55 abstract getWeekNumber(week: readonly NgbDate[], firstDayOfWeek: number): number;
56 /**
57 * Returns the today's date.
58 */
59 abstract getToday(): NgbDate;
60 /**
61 * Checks if a date is valid in the current calendar.
62 */
63 abstract isValid(date?: NgbDate | null): boolean;
64 static ɵfac: i0.ɵɵFactoryDeclaration<NgbCalendar, never>;
65 static ɵprov: i0.ɵɵInjectableDeclaration<NgbCalendar>;
66}
67export declare class NgbCalendarGregorian extends NgbCalendar {
68 getDaysPerWeek(): number;
69 getMonths(): number[];
70 getWeeksPerMonth(): number;
71 getNext(date: NgbDate, period?: NgbPeriod, number?: number): NgbDate;
72 getPrev(date: NgbDate, period?: NgbPeriod, number?: number): NgbDate;
73 getWeekday(date: NgbDate): number;
74 getWeekNumber(week: readonly NgbDate[], firstDayOfWeek: number): number;
75 getToday(): NgbDate;
76 isValid(date?: NgbDate | null): boolean;
77 static ɵfac: i0.ɵɵFactoryDeclaration<NgbCalendarGregorian, never>;
78 static ɵprov: i0.ɵɵInjectableDeclaration<NgbCalendarGregorian>;
79}