Skip to content

isNorthernHemisphere

Determines whether a country sits in the northern hemisphere by looking up its latitude in the bundled country table.

Importing

ts
import { isNorthernHemisphere } from '@basmilius/utils';

Usage

ts
import { isNorthernHemisphere } from '@basmilius/utils';

isNorthernHemisphere('nl'); // => true
isNorthernHemisphere('au'); // => false
isNorthernHemisphere('zz'); // => null (unknown country)

Parameters

NameTypeDescription
countryCodeCountryCodeISO 3166-1 alpha-2 country code (lowercase).

Returns

boolean | nulltrue for latitudes >= 0, false for southern hemisphere countries, null when the country code is not in the lookup table.

Type signature

ts
declare function isNorthernHemisphere(countryCode: CountryCode): boolean | null;

See also