mirror of
https://github.com/holidayapi/holidayapi-node.git
synced 2025-06-21 04:26:33 +00:00
Josh Sherman
2230488d14
Added support for our latest endpoint, which calculates the workday a given number of business days into the future from the given date for the given country. Also: * perf: updated dependencies * ci: pinned eslint to 7.2.x due to airbnb incompatibility with 7.3.x. * ci: tweaked / improved eslint rules a bit. * refactor: updated types to use `;` and include weekday response. * docs: added example for new endpoint.
91 lines
2.3 KiB
TypeScript
91 lines
2.3 KiB
TypeScript
export declare type Endpoint = 'countries' | 'holidays' | 'languages' | 'workday';
|
|
declare type Weekday = {
|
|
name: 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday';
|
|
numeric: 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
};
|
|
declare type Request = {
|
|
format?: 'csv' | 'json' | 'php' | 'tsv' | 'xml' | 'yaml';
|
|
key?: string;
|
|
pretty?: boolean;
|
|
search?: string;
|
|
};
|
|
export declare type Requests = CountriesRequest | HolidaysRequest | LanguagesRequest | WorkdayRequest;
|
|
export declare type CountriesRequest = Request & {
|
|
country?: string;
|
|
public?: boolean;
|
|
};
|
|
export declare type HolidaysRequest = Request & {
|
|
country?: string;
|
|
day?: number;
|
|
language?: string;
|
|
month?: number;
|
|
previous?: boolean;
|
|
public?: boolean;
|
|
subdivisions?: boolean;
|
|
upcoming?: boolean;
|
|
year?: number;
|
|
};
|
|
export declare type LanguagesRequest = Request & {
|
|
language?: string;
|
|
};
|
|
export declare type WorkdayRequest = Request & {
|
|
country?: string;
|
|
start?: string;
|
|
days?: number;
|
|
};
|
|
export declare type Response = {
|
|
requests: {
|
|
available: number;
|
|
resets: Date;
|
|
used: number;
|
|
};
|
|
status: number;
|
|
error?: string;
|
|
};
|
|
export declare type Responses = CountriesResponse | HolidaysResponse | LanguagesResponse | WorkdayResponse;
|
|
export declare type CountriesResponse = Response & {
|
|
countries?: {
|
|
code: string;
|
|
codes: {
|
|
'alpha-2': string;
|
|
'alpha-3': string;
|
|
numeric: string;
|
|
};
|
|
flag: string;
|
|
languages: string[];
|
|
name: string;
|
|
subdivisions: {
|
|
code: string;
|
|
languages: string[];
|
|
name: string;
|
|
}[];
|
|
weekday: {
|
|
date: Weekday;
|
|
observed: Weekday;
|
|
};
|
|
}[];
|
|
};
|
|
export declare type HolidaysResponse = Response & {
|
|
holidays?: {
|
|
country: string;
|
|
date: Date;
|
|
name: string;
|
|
observed: Date;
|
|
public: boolean;
|
|
uuid: string;
|
|
subdivisions?: string[];
|
|
}[];
|
|
};
|
|
export declare type LanguagesResponse = Response & {
|
|
languages?: {
|
|
code: string;
|
|
name: string;
|
|
}[];
|
|
};
|
|
export declare type WorkdayResponse = Response & {
|
|
workday?: {
|
|
date: Date;
|
|
weekday: Weekday;
|
|
};
|
|
};
|
|
export {};
|