DefinitelyTyped/types/provinces/index.d.ts
Nathan Shively-Sanders f0e6c97928 Add missing authors.
Uncovered by dtslint 0.5.4, which now requires that definitions cannot
be by "My Self", which is the default from dts-gen.
2019-03-11 09:09:21 -07:00

40 lines
977 B
TypeScript

// Type definitions for provinces 1.11
// Project: https://github.com/substack/provinces
// Definitions by: William Lohan <https://github.com/gatimus>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare global {
/**
* @see {@link https://github.com/substack/provinces#data-format}
*/
interface Province {
/**
* full name of the province or state
*/
name: string;
/**
* country abbreviation
*/
country: string;
/**
* optional 2 or 3 character short name
*/
short?: string;
/**
* optional array of additional names and abbreviations
*/
alt?: string[];
/**
* optional region of a country (for example: "Wales")
*/
region?: string;
}
}
/**
* @see {@link https://github.com/substack/provinces#methods}
*/
declare const provinces: Province[];
export = provinces;