Files
DefinitelyTyped/d3-time-format/index.d.ts
Tom Wanzek 86baab4f54 d3-selection and version numbers.
* d3-selection: Templated `Local` to allow generic parameter for datum type. Added additonal signatures to `Selection.property(...)` to accept `Local` as first argument. (Thanks to @gustavderdrache for catching these enhancements)
* Updated version numbers header comments to be current.
2016-08-20 13:06:14 -04:00

78 lines
2.7 KiB
TypeScript

// Type definitions for d3JS d3-time-format module v2.0.2
// Project: https://github.com/d3/d3-time-format/
// Definitions by: Tom Wanzek <https://github.com/tomwanzek>, Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* Specification of time locale to use when creating a new TimeLocaleObject
*/
export interface TimeLocaleDefinition {
/**
* The date and time (%c) format specifier (e.g., "%a %b %e %X %Y").
*/
dateTime: string;
/**
* The date (%x) format specifier (e.g., "%m/%d/%Y").
*/
date: string;
/**
* The time (%X) format specifier (e.g., "%H:%M:%S").
*/
time: string;
/**
* The A.M. and P.M. equivalents (e.g., ["AM", "PM"]).
*/
periods: [string, string];
/**
* The full names of the weekdays, starting with Sunday.
*/
days: [string, string, string, string, string, string, string];
/**
* The abbreviated names of the weekdays, starting with Sunday.
*/
shortDays: [string, string, string, string, string, string, string];
/**
* The full names of the months (starting with January).
*/
months: [string, string, string, string, string, string, string, string, string, string, string, string];
/**
* the abbreviated names of the months (starting with January).
*/
shortMonths: [string, string, string, string, string, string, string, string, string, string, string, string];
}
export interface TimeLocaleObject {
format(specifier: string): (date: Date) => string;
parse(specifier: string): (dateString: string) => (Date | null);
utcFormat(specifier: string): (date: Date) => string;
utcParse(specifier: string): (dateString: string) => (Date | null);
}
/**
* Create a new time-locale-based object which exposes time-formatting
* methods for the specified locale definition.
*/
export function timeFormatLocale(timeLocale: TimeLocaleDefinition): TimeLocaleObject;
/**
* Create a new time-locale-based object which exposes time-formatting
* methods for the specified locale definition. The new time locale definition
* will be set as the new default time locale.
*/
export function timeFormatDefaultLocale(defaultTimeLocale: TimeLocaleDefinition): TimeLocaleObject;
export function timeFormat(specifier: string): (date: Date) => string;
export function timeParse(specifier: string): (dateString: string) => (Date | null);
export function utcFormat(specifier: string): (date: Date) => string;
export function utcParse(specifier: string): (dateString: string) => (Date | null);
export function isoFormat(date: Date): string;
export function isoParse(dateString: string): Date;