# @types/provinces

> TypeScript definitions for provinces

Latest version **1.11.6** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/provinces
pnpm add @types/provinces
yarn add @types/provinces
bun add @types/provinces
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.11.6 |
| Published | 2023-11-07 |
| First published | 2017-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/provinces
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/provinces
- npm.io page: https://npm.io/package/@types/provinces

## Recent versions

- 1.11.6 (latest) — 2023-11-07
- 1.11.4 (ts3.8) — 2021-12-24
- 1.11.3 (ts3.7) — 2021-09-11
- 1.11.2 (ts3.6) — 2021-07-08
- 1.11.1 (ts2.0) — 2019-03-11
- 1.11.5 — 2023-10-18
- 1.11.0 — 2017-12-28

## README

# Installation
> `npm install --save @types/provinces`

# Summary
This package contains type definitions for provinces (https://github.com/substack/provinces).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/provinces.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/provinces/index.d.ts)
````ts
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 | undefined;
        /**
         * optional array of additional names and abbreviations
         */
        alt?: string[] | undefined;
        /**
         * optional region of a country (for example: "Wales")
         */
        region?: string | undefined;
        /**
         * optional English name of a country (for example: "Beijing")
         */
        english?: string | undefined;
    }
}

/**
 * @see {@link https://github.com/substack/provinces#methods}
 */
declare const provinces: Province[];

export = provinces;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by .

---
_Source: https://npm.io/package/@types/provinces · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._