Class Country

A class representing a parkrun country.

Hierarchy

Country

Index

Constructors

Methods

getAllEvents getAllEventNames getCode getName getIsActive getSiteURL getLanguageID getWikiName getCCTLD

Constructors

constructor

new Country(res: any, _core: Parkrun): Country
Parameters
- res: any
- _core: Parkrun
Returns Country
- Defined in src/classes/Country.ts:15

Methods

getAllEvents

getAllEvents(): Promise<Event[]>
Get an array of all the events in this country.

See
- (Borrows from getAllEventsByCountry)
- getAllEvents
Returns

Throws
ParkrunNetError ParkrunJS Networking Error.
Returns Promise<Event[]>
- Defined in src/classes/Country.ts:35

getAllEventNames

getAllEventNames(): Promise<String[]>
Get an array with the names of all parkrun events in this country, in alphabetical order.

See
- (Borrows from getAllEventNamesByCountry)
- getAllEventNames
Returns

Throws
ParkrunNetError ParkrunJS Networking Error.
Returns Promise<String[]>
- Defined in src/classes/Country.ts:48

getCode

getCode(): number
Get the country code for this country.

Returns
Country code.

Returns number
- Defined in src/classes/Country.ts:57

getName

getName(): string
Get the name for this country.

Returns
Country name.

Returns string
- Defined in src/classes/Country.ts:66

getIsActive

getIsActive(): boolean
Boolean describing weather the specified country is active or not.

Returns
country is active?

Returns boolean
- Defined in src/classes/Country.ts:75

getSiteURL

getSiteURL(): string
Get the site URL for this country.

Returns
Site URL

Example
```
country.getSiteURL(); // 'www.parkrun.org.uk
```
Returns string
- Defined in src/classes/Country.ts:87

getLanguageID

getLanguageID(): number
Get the Language ID for this country.

Returns
Language ID.

Returns number
- Defined in src/classes/Country.ts:96

getWikiName

getWikiName(): string
Get the Wiki Name for this country.

Returns
Wiki Name.

Example
```
country.getWikiName(); // 'UK'
```
Returns string
- Defined in src/classes/Country.ts:108

getCCTLD

getCCTLD(): string
Get the Country-Code Top Level Domain (ccTLD) for this country.

Returns
ccTLD.

Example
```
country.getCCTLD(); // 'uk'
```
Returns string
- Defined in src/classes/Country.ts:120

Generated using TypeDoc