The user's location.

interface UserLocation {
    city?: null | string;
    country?: null | string;
    region?: null | string;
    timezone?: null | string;
    type: "approximate";
}

Properties

city?: null | string

Free text input for the city of the user, e.g. San Francisco.

country?: null | string

The two-letter ISO country code of the user, e.g. US.

region?: null | string

Free text input for the region of the user, e.g. California.

timezone?: null | string

The IANA timezone of the user, e.g. America/Los_Angeles.

type: "approximate"

The type of location approximation. Always approximate.