Back to Vercel

Interface: Geo

packages/functions/docs/interfaces/index.Geo.md

16.1.22.4 KB
Original Source

Interface: Geo

index.Geo

The location information of a given request.

Table of contents

Properties

Properties

city

Optional city: string

The city that the request originated from.

Defined in

packages/functions/src/headers.ts:59


country

Optional country: string

The country that the request originated from.

Defined in

packages/functions/src/headers.ts:62


countryRegion

Optional countryRegion: string

The region part of the ISO 3166-2 code of the client IP. See docs.

Defined in

packages/functions/src/headers.ts:73


flag

Optional flag: string

The flag emoji for the country the request originated from.

Defined in

packages/functions/src/headers.ts:65


latitude

Optional latitude: string

The latitude of the client.

Defined in

packages/functions/src/headers.ts:76


longitude

Optional longitude: string

The longitude of the client.

Defined in

packages/functions/src/headers.ts:79


postalCode

Optional postalCode: string

The postal code of the client

Defined in

packages/functions/src/headers.ts:82


region

Optional region: string

The Vercel Edge Network region that received the request.

Defined in

packages/functions/src/headers.ts:68