diff --git a/classes/Client.html b/classes/Client.html index abdf8cb709..39f2228376 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -6,7 +6,7 @@

Instantiate with axiosInstance Advanced

const axiosInstance = axios.create(config)
const client = Client({axiosInstance})
-

Constructors

Constructors

Properties

Methods

Constructors

Properties

axiosInstance: AxiosInstance
experienceId: string[]

Methods

  • An example use of this function.

    +

Constructors

Properties

axiosInstance: AxiosInstance
experienceId: string[]

Methods

\ No newline at end of file +

Parameters

Returns Promise<GeocodeResponse>

\ No newline at end of file diff --git a/enums/AspectRatingType.html b/enums/AspectRatingType.html index beb8ad0959..e4624b7076 100644 --- a/enums/AspectRatingType.html +++ b/enums/AspectRatingType.html @@ -1,4 +1,4 @@ -AspectRatingType | Google Maps Services Node Client

Enumeration Members

appeal +AspectRatingType | Google Maps Services Node Client

Enumeration Members

Enumeration Members

appeal: "appeal"
atmosphere: "atmosphere"
decor: "decor"
facilities: "facilities"
food: "food"
overall: "overall"
quality: "quality"
service: "service"
\ No newline at end of file +

Enumeration Members

appeal: "appeal"
atmosphere: "atmosphere"
decor: "decor"
facilities: "facilities"
food: "food"
overall: "overall"
quality: "quality"
service: "service"
\ No newline at end of file diff --git a/enums/DirectionsReponseStatus.html b/enums/DirectionsReponseStatus.html index edd1ebc5d0..66ee8fa38a 100644 --- a/enums/DirectionsReponseStatus.html +++ b/enums/DirectionsReponseStatus.html @@ -1,6 +1,6 @@ DirectionsReponseStatus | Google Maps Services Node Client

The status field within the Directions response object contains the status of the request, and may contain debugging information to help you track down why the Directions service failed.

-

Deprecated

Enumeration Members

Deprecated

Enumeration Members

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid. Common causes of this status include an invalid parameter or parameter value.

-
MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-
MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-
NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

-
OK: "OK"

indicates the response contains a valid result.

-
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+
NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

+
OK: "OK"

indicates the response contains a valid result.

+
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
  • @@ -27,8 +27,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

-
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

-
ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

-
\ No newline at end of file +
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

+
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

+
ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

+
\ No newline at end of file diff --git a/enums/DirectionsResponseStatus.html b/enums/DirectionsResponseStatus.html index a4f44987c1..e17305bf3f 100644 --- a/enums/DirectionsResponseStatus.html +++ b/enums/DirectionsResponseStatus.html @@ -1,6 +1,6 @@ DirectionsResponseStatus | Google Maps Services Node Client

The status field within the Directions response object contains the status of the request, and may contain debugging information to help you track down why the Directions service failed.

-

Enumeration Members

Enumeration Members

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid. Common causes of this status include an invalid parameter or parameter value.

-
MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-
MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-
NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

-
OK: "OK"

indicates the response contains a valid result.

-
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+
NOT_FOUND: "NOT_FOUND"

indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded.

+
OK: "OK"

indicates the response contains a valid result.

+
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
  • @@ -27,8 +27,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

-
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

-
ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

-
\ No newline at end of file +
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the directions service by your application.

+
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a directions request could not be processed due to a server error. The request may succeed if you try again.

+
ZERO_RESULTS: "ZERO_RESULTS"

indicates no route could be found between the origin and destination.

+
\ No newline at end of file diff --git a/enums/GeocodedWaypointStatus.html b/enums/GeocodedWaypointStatus.html index c0a20e8dc9..a7f9aa23a8 100644 --- a/enums/GeocodedWaypointStatus.html +++ b/enums/GeocodedWaypointStatus.html @@ -1,6 +1,6 @@ -GeocodedWaypointStatus | Google Maps Services Node Client

Enumeration Members

OK +GeocodedWaypointStatus | Google Maps Services Node Client

Enumeration Members

Enumeration Members

OK: "OK"

indicates that no errors occurred; the address was successfully parsed and at least one geocode was returned.

-
ZERO_RESULTS: "ZERO_RESULTS"

indicates that the geocode was successful but returned no results. +

ZERO_RESULTS: "ZERO_RESULTS"

indicates that the geocode was successful but returned no results. This may occur if the geocoder was passed a non-existent address.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/GeocodingAddressComponentType.html b/enums/GeocodingAddressComponentType.html index 8ac90b2039..1109ed4df9 100644 --- a/enums/GeocodingAddressComponentType.html +++ b/enums/GeocodingAddressComponentType.html @@ -1,4 +1,4 @@ -GeocodingAddressComponentType | Google Maps Services Node Client

Enumeration GeocodingAddressComponentType

Enumeration Members

bus_station +GeocodingAddressComponentType | Google Maps Services Node Client

Enumeration GeocodingAddressComponentType

Enumeration Members

Enumeration Members

bus_station: "bus_station"

indicate the location of a bus.

-
establishment: "establishment"

typically indicates a place that has not yet been categorized.

-
floor: "floor"

indicates the floor of a building address.

-
parking: "parking"

indicates a parking lot or parking structure.

-
point_of_interest: "point_of_interest"

indicates a named point of interest.

-
post_box: "post_box"

indicates a specific postal box.

-
postal_town: "postal_town"

indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

-
room: "room"

indicates the room of a building address.

-
street_number: "street_number"

indicates the precise street number.

-
train_station: "train_station"

indicate the location of a train.

-
transit_station: "transit_station"

indicate the location of a public transit stop.

-
\ No newline at end of file +
establishment: "establishment"

typically indicates a place that has not yet been categorized.

+
floor: "floor"

indicates the floor of a building address.

+
parking: "parking"

indicates a parking lot or parking structure.

+
point_of_interest: "point_of_interest"

indicates a named point of interest.

+
post_box: "post_box"

indicates a specific postal box.

+
postal_town: "postal_town"

indicates a grouping of geographic areas, such as locality and sublocality, used for mailing addresses in some countries.

+
room: "room"

indicates the room of a building address.

+
street_number: "street_number"

indicates the precise street number.

+
train_station: "train_station"

indicate the location of a train.

+
transit_station: "transit_station"

indicate the location of a public transit stop.

+
\ No newline at end of file diff --git a/enums/GeolocateErrorReason.html b/enums/GeolocateErrorReason.html index c88673dd79..1d4e1649a2 100644 --- a/enums/GeolocateErrorReason.html +++ b/enums/GeolocateErrorReason.html @@ -1,4 +1,4 @@ -GeolocateErrorReason | Google Maps Services Node Client

Enumeration Members

dailyLimitExceeded +GeolocateErrorReason | Google Maps Services Node Client

Enumeration Members

Enumeration Members

dailyLimitExceeded: "dailyLimitExceeded"

You have exceeded your daily limit. Domain: usageLimits Code: 403

-
keyInvalid: "keyInvalid"

Your API key is not valid for the Geolocate API. Please ensure that you've included the entire key, +

keyInvalid: "keyInvalid"

Your API key is not valid for the Geolocate API. Please ensure that you've included the entire key, and that you've either purchased the API or have enabled billing and activated the API to obtain the free quota. Domain: usageLimits Code: 400

-
notFound: "notFound"

The request was valid, but no results were returned. +

notFound: "notFound"

The request was valid, but no results were returned. Domain: geolocation Code: 404

-
parseError: "parseError"

The request body is not valid JSON. Refer to the Request Body section for details on each field. +

parseError: "parseError"

The request body is not valid JSON. Refer to the Request Body section for details on each field. Domain: global Code: 400

-
userRateLimitExceeded: "userRateLimitExceeded"

You have exceeded the requests per second per user limit that you configured in the Google Cloud Platform Console. +

userRateLimitExceeded: "userRateLimitExceeded"

You have exceeded the requests per second per user limit that you configured in the Google Cloud Platform Console. This limit should be configured to prevent a single or small group of users from exhausting your daily quota, while still allowing reasonable access to all users. Domain: usageLimits Code: 403

-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/Language.html b/enums/Language.html index 28dee196eb..4cde14f4df 100644 --- a/enums/Language.html +++ b/enums/Language.html @@ -1,7 +1,7 @@ Language | Google Maps Services Node Client

By default the API will attempt to load the most appropriate language based on the users location or browser settings. Some APIs allow you to explicitly set a language when you make a request

Enumeration Members

ar +

Enumeration Members

ar be bg bn @@ -63,64 +63,64 @@ zh_CN zh_TW

Enumeration Members

ar: "ar"

Arabic

-
be: "be"

Belarusian

-
bg: "bg"

Bulgarian

-
bn: "bn"

Bengali

-
ca: "ca"

Catalan

-
cs: "cs"

Czech

-
da: "da"

Danish

-
de: "de"

German

-
el: "el"

Greek

-
en: "en"

English

-
en_Au: "en-Au"

English (Australian)

-
en_GB: "en-GB"

English (Great Britain)

-
es: "es"

Spanish

-
eu: "eu"

Basque

-
fa: "fa"

Farsi

-
fi: "fi"

Finnish

-
fil: "fil"

Filipino

-
fr: "fr"

French

-
gl: "gl"

Galician

-
gu: "gu"

Gujarati

-
hi: "hi"

Hindi

-
hr: "hr"

Croatian

-
hu: "hu"

Hungarian

-
id: "id"

Indonesian

-
it: "it"

Italian

-
iw: "iw"

Hebrew

-
ja: "ja"

Japanese

-
kk: "kk"

Kazakh

-
kn: "kn"

Kannada

-
ko: "ko"

Korean

-
ky: "ky"

Kyrgyz

-
lt: "lt"

Lithuanian

-
lv: "lv"

Latvian

-
mk: "mk"

Macedonian

-
ml: "ml"

Malayalam

-
mr: "mr"

Marathi

-
my: "my"

Burmese

-
nl: "nl"

Dutch

-
no: "no"

Norwegian

-
pa: "pa"

Punjabi

-
pl: "pl"

Polish

-
pt: "pt"

Portuguese

-
pt_BR: "pt-BR"

Portuguese (Brazil)

-
pt_PT: "pt-PT"

Portuguese (Portugal)

-
ro: "ro"

Romanian

-
ru: "ru"

Russian

-
sk: "sk"

Slovak

-
sl: "sl"

Slovenian

-
sq: "sq"

Albanian

-
sr: "sr"

Serbian

-
sv: "sv"

Swedish

-
ta: "ta"

Tamil

-
te: "te"

Telugu

-
th: "th"

Thai

-
tl: "tl"

Tagalog

-
tr: "tr"

Turkish

-
uk: "uk"

Ukrainian

-
uz: "uz"

Uzbek

-
vi: "vi"

Vietnamese

-
zh_CN: "zh-CN"

Chinese (Simlified)

-
zh_TW: "zh-TW"

Chinese (Traditional)

-
\ No newline at end of file +
be: "be"

Belarusian

+
bg: "bg"

Bulgarian

+
bn: "bn"

Bengali

+
ca: "ca"

Catalan

+
cs: "cs"

Czech

+
da: "da"

Danish

+
de: "de"

German

+
el: "el"

Greek

+
en: "en"

English

+
en_Au: "en-Au"

English (Australian)

+
en_GB: "en-GB"

English (Great Britain)

+
es: "es"

Spanish

+
eu: "eu"

Basque

+
fa: "fa"

Farsi

+
fi: "fi"

Finnish

+
fil: "fil"

Filipino

+
fr: "fr"

French

+
gl: "gl"

Galician

+
gu: "gu"

Gujarati

+
hi: "hi"

Hindi

+
hr: "hr"

Croatian

+
hu: "hu"

Hungarian

+
id: "id"

Indonesian

+
it: "it"

Italian

+
iw: "iw"

Hebrew

+
ja: "ja"

Japanese

+
kk: "kk"

Kazakh

+
kn: "kn"

Kannada

+
ko: "ko"

Korean

+
ky: "ky"

Kyrgyz

+
lt: "lt"

Lithuanian

+
lv: "lv"

Latvian

+
mk: "mk"

Macedonian

+
ml: "ml"

Malayalam

+
mr: "mr"

Marathi

+
my: "my"

Burmese

+
nl: "nl"

Dutch

+
no: "no"

Norwegian

+
pa: "pa"

Punjabi

+
pl: "pl"

Polish

+
pt: "pt"

Portuguese

+
pt_BR: "pt-BR"

Portuguese (Brazil)

+
pt_PT: "pt-PT"

Portuguese (Portugal)

+
ro: "ro"

Romanian

+
ru: "ru"

Russian

+
sk: "sk"

Slovak

+
sl: "sl"

Slovenian

+
sq: "sq"

Albanian

+
sr: "sr"

Serbian

+
sv: "sv"

Swedish

+
ta: "ta"

Tamil

+
te: "te"

Telugu

+
th: "th"

Thai

+
tl: "tl"

Tagalog

+
tr: "tr"

Turkish

+
uk: "uk"

Ukrainian

+
uz: "uz"

Uzbek

+
vi: "vi"

Vietnamese

+
zh_CN: "zh-CN"

Chinese (Simlified)

+
zh_TW: "zh-TW"

Chinese (Traditional)

+
\ No newline at end of file diff --git a/enums/LocationType.html b/enums/LocationType.html index a21826c6d3..83b8b2719f 100644 --- a/enums/LocationType.html +++ b/enums/LocationType.html @@ -1,12 +1,12 @@ -LocationType | Google Maps Services Node Client

Enumeration Members

APPROXIMATE +LocationType | Google Maps Services Node Client

Enumeration Members

APPROXIMATE: "APPROXIMATE"

indicates that the returned result is approximate.

-
GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

indicates that the returned result is the geometric center of a result such as a polyline +

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

indicates that the returned result is the geometric center of a result such as a polyline (for example, a street) or polygon (region).

-
RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

indicates that the returned result reflects an approximation (usually on a road) interpolated between two precise points +

RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

indicates that the returned result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.

-
ROOFTOP: "ROOFTOP"

indicates that the returned result is a precise geocode for which we have location information +

ROOFTOP: "ROOFTOP"

indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision

-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/Maneuver.html b/enums/Maneuver.html index 80b126cd41..943f381486 100644 --- a/enums/Maneuver.html +++ b/enums/Maneuver.html @@ -1,4 +1,4 @@ -Maneuver | Google Maps Services Node Client

Enumeration Members

ferry +Maneuver | Google Maps Services Node Client

Enumeration Members

ferry: "ferry"
ferry_train: "ferry-train"
fork_left: "fork-left"
fork_right: "fork-right"
merge: "merge"
ramp_left: "ramp-left"
ramp_right: "ramp-right"
roundabout_left: "roundabout-left"
roundabout_right: "roundabout-right"
straight: "straight"
turn_left: "turn-left"
turn_right: "turn-right"
turn_sharp_left: "turn-sharp-left"
turn_sharp_right: "turn-sharp-right"
turn_slight_left: "turn-slight-left"
turn_slight_right: "turn-slight-right"
uturn_left: "uturn-left"
uturn_right: "uturn-right"
\ No newline at end of file +

Enumeration Members

ferry: "ferry"
ferry_train: "ferry-train"
fork_left: "fork-left"
fork_right: "fork-right"
merge: "merge"
ramp_left: "ramp-left"
ramp_right: "ramp-right"
roundabout_left: "roundabout-left"
roundabout_right: "roundabout-right"
straight: "straight"
turn_left: "turn-left"
turn_right: "turn-right"
turn_sharp_left: "turn-sharp-left"
turn_sharp_right: "turn-sharp-right"
turn_slight_left: "turn-slight-left"
turn_slight_right: "turn-slight-right"
uturn_left: "uturn-left"
uturn_right: "uturn-right"
\ No newline at end of file diff --git a/enums/PlaceAutocompleteType.html b/enums/PlaceAutocompleteType.html index 96ebeab735..7404439f42 100644 --- a/enums/PlaceAutocompleteType.html +++ b/enums/PlaceAutocompleteType.html @@ -1,15 +1,15 @@ -PlaceAutocompleteType | Google Maps Services Node Client

Enumeration Members

address +PlaceAutocompleteType | Google Maps Services Node Client

Enumeration Members

address: "address"

instructs the Place Autocomplete service to return only geocoding results with a precise address. Generally, you use this request when you know the user will be looking for a fully specified address.

-
cities: "(cities)"

the (cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.

-
establishment: "establishment"

instructs the Place Autocomplete service to return only business results.

-
geocode: "geocode"

instructs the Place Autocomplete service to return only geocoding results, rather than business results. +

cities: "(cities)"

the (cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.

+
establishment: "establishment"

instructs the Place Autocomplete service to return only business results.

+
geocode: "geocode"

instructs the Place Autocomplete service to return only geocoding results, rather than business results. Generally, you use this request to disambiguate results where the location specified may be indeterminate.

-
regions: "(regions)"

the (regions) type collection instructs the Places service to return any result matching the following types:

+
regions: "(regions)"

the (regions) type collection instructs the Places service to return any result matching the following types:

  • locality
  • sublocality
  • @@ -18,4 +18,4 @@
  • administrative_area_level_1
  • administrative_area_level_2
-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/PlaceIdScope.html b/enums/PlaceIdScope.html index 0bf5ea2ecb..a628bc21c8 100644 --- a/enums/PlaceIdScope.html +++ b/enums/PlaceIdScope.html @@ -1,6 +1,6 @@ -PlaceIdScope | Google Maps Services Node Client

Enumeration Members

APP +PlaceIdScope | Google Maps Services Node Client

Enumeration Members

Enumeration Members

APP: "APP"

The place ID is recognised by your application only. This is because your application added the place, and the place has not yet passed the moderation process.

-
GOOGLE: "GOOGLE"

The place ID is available to other applications and on Google Maps.

-
\ No newline at end of file +
GOOGLE: "GOOGLE"

The place ID is available to other applications and on Google Maps.

+
\ No newline at end of file diff --git a/enums/PlaceInputType.html b/enums/PlaceInputType.html index d4f8a0c33c..888e16e005 100644 --- a/enums/PlaceInputType.html +++ b/enums/PlaceInputType.html @@ -1,3 +1,3 @@ -PlaceInputType | Google Maps Services Node Client

Enumeration Members

phoneNumber +PlaceInputType | Google Maps Services Node Client

Enumeration Members

Enumeration Members

phoneNumber: "phonenumber"
textQuery: "textquery"
\ No newline at end of file +

Enumeration Members

phoneNumber: "phonenumber"
textQuery: "textquery"
\ No newline at end of file diff --git a/enums/PlaceType1.html b/enums/PlaceType1.html index 30300e7c95..f40cd7c7a4 100644 --- a/enums/PlaceType1.html +++ b/enums/PlaceType1.html @@ -1,7 +1,7 @@ PlaceType1 | Google Maps Services Node Client

Table 1: Types supported in place search and addition

You can use the following values in the types filter for place searches and when adding a place.

Enumeration Members

Enumeration Members

Enumeration Members

accounting: "accounting"
airport: "airport"

indicates an airport.

-
amusement_park: "amusement_park"
aquarium: "aquarium"
art_gallery: "art_gallery"
atm: "atm"
bakery: "bakery"
bank: "bank"
bar: "bar"
beauty_salon: "beauty_salon"
bicycle_store: "bicycle_store"
book_store: "book_store"
bowling_alley: "bowling_alley"
bus_station: "bus_station"
cafe: "cafe"
campground: "campground"
car_dealer: "car_dealer"
car_rental: "car_rental"
car_repair: "car_repair"
car_wash: "car_wash"
casino: "casino"
cemetery: "cemetery"
church: "church"
city_hall: "city_hall"
clothing_store: "clothing_store"
convenience_store: "convenience_store"
courthouse: "courthouse"
dentist: "dentist"
department_store: "department_store"
doctor: "doctor"
drugstore: "drugstore"
electrician: "electrician"
electronics_store: "electronics_store"
embassy: "embassy"
fire_station: "fire_station"
florist: "florist"
funeral_home: "funeral_home"
furniture_store: "furniture_store"
gas_station: "gas_station"
gym: "gym"
hair_care: "hair_care"
hardware_store: "hardware_store"
hindu_temple: "hindu_temple"
home_goods_store: "home_goods_store"
hospital: "hospital"
insurance_agency: "insurance_agency"
jewelry_store: "jewelry_store"
laundry: "laundry"
lawyer: "lawyer"
library: "library"
light_rail_station: "light_rail_station"
liquor_store: "liquor_store"
local_government_office: "local_government_office"
locksmith: "locksmith"
lodging: "lodging"
meal_delivery: "meal_delivery"
meal_takeaway: "meal_takeaway"
mosque: "mosque"
movie_rental: "movie_rental"
movie_theater: "movie_theater"
moving_company: "moving_company"
museum: "museum"
night_club: "night_club"
painter: "painter"
park: "park"

indicates a named park.

-
parking: "parking"
pet_store: "pet_store"
pharmacy: "pharmacy"
physiotherapist: "physiotherapist"
plumber: "plumber"
police: "police"
post_office: "post_office"
real_estate_agency: "real_estate_agency"
restaurant: "restaurant"
roofing_contractor: "roofing_contractor"
rv_park: "rv_park"
school: "school"
secondary_school: "secondary_school"
shoe_store: "shoe_store"
shopping_mall: "shopping_mall"
spa: "spa"
stadium: "stadium"
storage: "storage"
store: "store"
subway_station: "subway_station"
supermarket: "supermarket"
synagogue: "synagogue"
taxi_stand: "taxi_stand"
tourist_attraction: "tourist_attraction"
train_station: "train_station"
transit_station: "transit_station"
travel_agency: "travel_agency"
university: "university"
veterinary_care: "veterinary_care"
zoo: "zoo"
\ No newline at end of file +

Enumeration Members

accounting: "accounting"
airport: "airport"

indicates an airport.

+
amusement_park: "amusement_park"
aquarium: "aquarium"
art_gallery: "art_gallery"
atm: "atm"
bakery: "bakery"
bank: "bank"
bar: "bar"
beauty_salon: "beauty_salon"
bicycle_store: "bicycle_store"
book_store: "book_store"
bowling_alley: "bowling_alley"
bus_station: "bus_station"
cafe: "cafe"
campground: "campground"
car_dealer: "car_dealer"
car_rental: "car_rental"
car_repair: "car_repair"
car_wash: "car_wash"
casino: "casino"
cemetery: "cemetery"
church: "church"
city_hall: "city_hall"
clothing_store: "clothing_store"
convenience_store: "convenience_store"
courthouse: "courthouse"
dentist: "dentist"
department_store: "department_store"
doctor: "doctor"
drugstore: "drugstore"
electrician: "electrician"
electronics_store: "electronics_store"
embassy: "embassy"
fire_station: "fire_station"
florist: "florist"
funeral_home: "funeral_home"
furniture_store: "furniture_store"
gas_station: "gas_station"
gym: "gym"
hair_care: "hair_care"
hardware_store: "hardware_store"
hindu_temple: "hindu_temple"
home_goods_store: "home_goods_store"
hospital: "hospital"
insurance_agency: "insurance_agency"
jewelry_store: "jewelry_store"
laundry: "laundry"
lawyer: "lawyer"
library: "library"
light_rail_station: "light_rail_station"
liquor_store: "liquor_store"
local_government_office: "local_government_office"
locksmith: "locksmith"
lodging: "lodging"
meal_delivery: "meal_delivery"
meal_takeaway: "meal_takeaway"
mosque: "mosque"
movie_rental: "movie_rental"
movie_theater: "movie_theater"
moving_company: "moving_company"
museum: "museum"
night_club: "night_club"
painter: "painter"
park: "park"

indicates a named park.

+
parking: "parking"
pet_store: "pet_store"
pharmacy: "pharmacy"
physiotherapist: "physiotherapist"
plumber: "plumber"
police: "police"
post_office: "post_office"
real_estate_agency: "real_estate_agency"
restaurant: "restaurant"
roofing_contractor: "roofing_contractor"
rv_park: "rv_park"
school: "school"
secondary_school: "secondary_school"
shoe_store: "shoe_store"
shopping_mall: "shopping_mall"
spa: "spa"
stadium: "stadium"
storage: "storage"
store: "store"
subway_station: "subway_station"
supermarket: "supermarket"
synagogue: "synagogue"
taxi_stand: "taxi_stand"
tourist_attraction: "tourist_attraction"
train_station: "train_station"
transit_station: "transit_station"
travel_agency: "travel_agency"
university: "university"
veterinary_care: "veterinary_care"
zoo: "zoo"
\ No newline at end of file diff --git a/enums/PlaceType2.html b/enums/PlaceType2.html index 735da230a0..a1c5cd2f3f 100644 --- a/enums/PlaceType2.html +++ b/enums/PlaceType2.html @@ -3,7 +3,7 @@ For more details on these types, refer to Address Types in Geocoding Responses.

See

https://developers.google.com/places/web-service/supported_types#table2

-

Enumeration Members

Enumeration Members

administrative_area_level_1 administrative_area_level_2 administrative_area_level_3 administrative_area_level_4 @@ -50,27 +50,27 @@ Not all nations exhibit these administrative levels. In most cases, administrative_area_level_1 short names will closely match ISO 3166-2 subdivisions and other widely circulated lists; however this is not guaranteed as our geocoding results are based on a variety of signals and location data.

-
administrative_area_level_2: "administrative_area_level_2"

indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. +

administrative_area_level_2: "administrative_area_level_2"

indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.

-
administrative_area_level_3: "administrative_area_level_3"

indicates a third-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_3: "administrative_area_level_3"

indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-
administrative_area_level_4: "administrative_area_level_4"

indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_4: "administrative_area_level_4"

indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-
administrative_area_level_5: "administrative_area_level_5"

indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. +

administrative_area_level_5: "administrative_area_level_5"

indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.

-
archipelago: "archipelago"
colloquial_area: "colloquial_area"

indicates a commonly-used alternative name for the entity.

-
continent: "continent"
country: "country"

indicates the national political entity, and is typically the highest order type returned by the Geocoder.

-
establishment: "establishment"
finance: "finance"
floor: "floor"
food: "food"
general_contractor: "general_contractor"
geocode: "geocode"
health: "health"
intersection: "intersection"

indicates a major intersection, usually of two major roads.

-
landmark: "landmark"
locality: "locality"

indicates an incorporated city or town political entity.

-
natural_feature: "natural_feature"

indicates a prominent natural feature.

-
neighborhood: "neighborhood"

indicates a named neighborhood

-
place_of_worship: "place_of_worship"
plus_code: "plus_code"
point_of_interest: "point_of_interest"
political: "political"

indicates a political entity. Usually, this type indicates a polygon of some civil administration.

-
post_box: "post_box"
postal_code: "postal_code"

indicates a postal code as used to address postal mail within the country.

-
postal_code_prefix: "postal_code_prefix"
postal_code_suffix: "postal_code_suffix"
postal_town: "postal_town"
premise: "premise"

indicates a named location, usually a building or collection of buildings with a common name

-
room: "room"
route: "route"

indicates a named route (such as "US 101").

-
street_address: "street_address"
street_number: "street_number"
sublocality: "sublocality"

indicates a first-order civil entity below a locality. For some locations may receive one of the additional types: +

archipelago: "archipelago"
colloquial_area: "colloquial_area"

indicates a commonly-used alternative name for the entity.

+
continent: "continent"
country: "country"

indicates the national political entity, and is typically the highest order type returned by the Geocoder.

+
establishment: "establishment"
finance: "finance"
floor: "floor"
food: "food"
general_contractor: "general_contractor"
geocode: "geocode"
health: "health"
intersection: "intersection"

indicates a major intersection, usually of two major roads.

+
landmark: "landmark"
locality: "locality"

indicates an incorporated city or town political entity.

+
natural_feature: "natural_feature"

indicates a prominent natural feature.

+
neighborhood: "neighborhood"

indicates a named neighborhood

+
place_of_worship: "place_of_worship"
plus_code: "plus_code"
point_of_interest: "point_of_interest"
political: "political"

indicates a political entity. Usually, this type indicates a polygon of some civil administration.

+
post_box: "post_box"
postal_code: "postal_code"

indicates a postal code as used to address postal mail within the country.

+
postal_code_prefix: "postal_code_prefix"
postal_code_suffix: "postal_code_suffix"
postal_town: "postal_town"
premise: "premise"

indicates a named location, usually a building or collection of buildings with a common name

+
room: "room"
route: "route"

indicates a named route (such as "US 101").

+
street_address: "street_address"
street_number: "street_number"
sublocality: "sublocality"

indicates a first-order civil entity below a locality. For some locations may receive one of the additional types: sublocality_level_1 to sublocality_level_5. Each sublocality level is a civil entity. Larger numbers indicate a smaller geographic area.

-
sublocality_level_1: "sublocality_level_1"
sublocality_level_2: "sublocality_level_2"
sublocality_level_3: "sublocality_level_3"
sublocality_level_4: "sublocality_level_4"
sublocality_level_5: "sublocality_level_5"
subpremise: "subpremise"

indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a +

sublocality_level_1: "sublocality_level_1"
sublocality_level_2: "sublocality_level_2"
sublocality_level_3: "sublocality_level_3"
sublocality_level_4: "sublocality_level_4"
sublocality_level_5: "sublocality_level_5"
subpremise: "subpremise"

indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common name.

-
town_square: "town_square"
\ No newline at end of file +
town_square: "town_square"
\ No newline at end of file diff --git a/enums/PlacesNearbyRanking.html b/enums/PlacesNearbyRanking.html index 634391ddab..3660c8770c 100644 --- a/enums/PlacesNearbyRanking.html +++ b/enums/PlacesNearbyRanking.html @@ -1,7 +1,7 @@ -PlacesNearbyRanking | Google Maps Services Node Client

Enumeration Members

distance +PlacesNearbyRanking | Google Maps Services Node Client

Enumeration Members

Enumeration Members

distance: "distance"

This option biases search results in ascending order by their distance from the specified location. When distance is specified, one or more of keyword, name, or type is required.

-
prominence: "prominence"

This option sorts results based on their importance. Ranking will favor prominent places within the specified area. +

prominence: "prominence"

This option sorts results based on their importance. Ranking will favor prominent places within the specified area. Prominence can be affected by a place's ranking in Google's index, global popularity, and other factors.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/RadioType.html b/enums/RadioType.html index 40f8d0714b..3b4467f1d4 100644 --- a/enums/RadioType.html +++ b/enums/RadioType.html @@ -1,5 +1,5 @@ -RadioType | Google Maps Services Node Client

Enumeration Members

cdma +RadioType | Google Maps Services Node Client

Enumeration Members

Enumeration Members

cdma: "cdma"
gsm: "gsm"
lte: "lte"
wcdma: "wcdma"
\ No newline at end of file +

Enumeration Members

cdma: "cdma"
gsm: "gsm"
lte: "lte"
wcdma: "wcdma"
\ No newline at end of file diff --git a/enums/ReverseGeocodingLocationType.html b/enums/ReverseGeocodingLocationType.html index 7d1be6f328..39bfec7463 100644 --- a/enums/ReverseGeocodingLocationType.html +++ b/enums/ReverseGeocodingLocationType.html @@ -1,12 +1,12 @@ ReverseGeocodingLocationType | Google Maps Services Node Client

Enumeration ReverseGeocodingLocationType

If both result_type and location_type filters are present then the API returns only those results that match both the result_type and the location_type values. If none of the filter values are acceptable, the API returns ZERO_RESULTS.

-

Enumeration Members

Enumeration Members

APPROXIMATE: "APPROXIMATE"

returns only the addresses that are characterized as approximate.

-
GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

returns only geometric centers of a location such as a polyline (for example, a street) or polygon (region).

-
RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

returns only the addresses that reflect an approximation (usually on a road) interpolated between two precise points +

GEOMETRIC_CENTER: "GEOMETRIC_CENTER"

returns only geometric centers of a location such as a polyline (for example, a street) or polygon (region).

+
RANGE_INTERPOLATED: "RANGE_INTERPOLATED"

returns only the addresses that reflect an approximation (usually on a road) interpolated between two precise points (such as intersections). An interpolated range generally indicates that rooftop geocodes are unavailable for a street address.

-
ROOFTOP: "ROOFTOP"

returns only the addresses for which Google has location information accurate down to street address precision.

-
\ No newline at end of file +
ROOFTOP: "ROOFTOP"

returns only the addresses for which Google has location information accurate down to street address precision.

+
\ No newline at end of file diff --git a/enums/Status.html b/enums/Status.html index 9adbebabf4..d8cbb87d2a 100644 --- a/enums/Status.html +++ b/enums/Status.html @@ -1,4 +1,4 @@ -Status | Google Maps Services Node Client

Enumeration Members

INVALID_REQUEST +Status | Google Maps Services Node Client

Enumeration Members

INVALID_REQUEST: "INVALID_REQUEST"

indicates that the provided request was invalid.

-
MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. +

MAX_ROUTE_LENGTH_EXCEEDED: "MAX_ROUTE_LENGTH_EXCEEDED"

indicates the requested route is too long and cannot be processed. This error occurs when more complex directions are returned. Try reducing the number of waypoints, turns, or instructions.

-
MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, +

MAX_WAYPOINTS_EXCEEDED: "MAX_WAYPOINTS_EXCEEDED"

indicates that too many waypoints were provided in the request. For applications using the Directions API as a web service, or the directions service in the Maps JavaScript API, the maximum allowed number of waypoints is 23, plus the origin and destination.

-
NOT_FOUND: "NOT_FOUND"

indicates that the referenced location (place_id) was not found in the Places database.

-
OK: "OK"

indicates the response contains a valid result.

-
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

+
NOT_FOUND: "NOT_FOUND"

indicates that the referenced location (place_id) was not found in the Places database.

+
OK: "OK"

indicates the response contains a valid result.

+
OVER_DAILY_LIMIT: "OVER_DAILY_LIMIT"

indicates any of the following:

  • The API key is missing or invalid.
  • Billing has not been enabled on your account.
  • @@ -25,8 +25,8 @@
  • The provided method of payment is no longer valid (for example, a credit card has expired). See the Maps FAQ to learn how to fix this.
-
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

-
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the Distance Matrix service by your application.

-
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

-
ZERO_RESULTS: "ZERO_RESULTS"

indicates that the request was successful but returned no results.

-
\ No newline at end of file +
OVER_QUERY_LIMIT: "OVER_QUERY_LIMIT"

indicates the service has received too many requests from your application within the allowed time period.

+
REQUEST_DENIED: "REQUEST_DENIED"

indicates that the service denied use of the Distance Matrix service by your application.

+
UNKNOWN_ERROR: "UNKNOWN_ERROR"

indicates a Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

+
ZERO_RESULTS: "ZERO_RESULTS"

indicates that the request was successful but returned no results.

+
\ No newline at end of file diff --git a/enums/TrafficModel.html b/enums/TrafficModel.html index e886e6cd5e..ed87babcc4 100644 --- a/enums/TrafficModel.html +++ b/enums/TrafficModel.html @@ -1,10 +1,10 @@ -TrafficModel | Google Maps Services Node Client

Enumeration Members

best_guess +TrafficModel | Google Maps Services Node Client

Enumeration Members

Enumeration Members

best_guess: "best_guess"

indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.

-
optimistic: "optimistic"

indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, +

optimistic: "optimistic"

indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

-
pessimistic: "pessimistic"

indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, +

pessimistic: "pessimistic"

indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/enums/TransitMode.html b/enums/TransitMode.html index 5eaf1ac2e0..85bff07e5c 100644 --- a/enums/TransitMode.html +++ b/enums/TransitMode.html @@ -1,12 +1,12 @@ -TransitMode | Google Maps Services Node Client

Enumeration Members

bus +TransitMode | Google Maps Services Node Client

Enumeration Members

Enumeration Members

bus: "bus"

indicates that the calculated route should prefer travel by bus.

-
rail: "rail"

indicates that the calculated route should prefer travel by train, tram, light rail, and subway. +

rail: "rail"

indicates that the calculated route should prefer travel by train, tram, light rail, and subway. This is equivalent to transit_mode=train|tram|subway

-
subway: "subway"

indicates that the calculated route should prefer travel by subway.

-
train: "train"

indicates that the calculated route should prefer travel by train.

-
tram: "tram"

indicates that the calculated route should prefer travel by tram and light rail.

-
\ No newline at end of file +
subway: "subway"

indicates that the calculated route should prefer travel by subway.

+
train: "train"

indicates that the calculated route should prefer travel by train.

+
tram: "tram"

indicates that the calculated route should prefer travel by tram and light rail.

+
\ No newline at end of file diff --git a/enums/TransitRoutingPreference.html b/enums/TransitRoutingPreference.html index 338ff9ead3..6ef56b307f 100644 --- a/enums/TransitRoutingPreference.html +++ b/enums/TransitRoutingPreference.html @@ -1,5 +1,5 @@ -TransitRoutingPreference | Google Maps Services Node Client

Enumeration Members

fewer_transfers +TransitRoutingPreference | Google Maps Services Node Client

Enumeration Members

Enumeration Members

fewer_transfers: "fewer_transfers"

indicates that the calculated route should prefer a limited number of transfers.

-
less_walking: "less_walking"

indicates that the calculated route should prefer limited amounts of walking.

-
\ No newline at end of file +
less_walking: "less_walking"

indicates that the calculated route should prefer limited amounts of walking.

+
\ No newline at end of file diff --git a/enums/TravelMode.html b/enums/TravelMode.html index 0e8682b90c..5e34e29caf 100644 --- a/enums/TravelMode.html +++ b/enums/TravelMode.html @@ -2,15 +2,15 @@ By default, directions are calculated as driving directions.

Note: Both walking and bicycling directions may sometimes not include clear pedestrian or bicycling paths, so these directions will return warnings in the returned result which you must display to the user.

-

Enumeration Members

Enumeration Members

Enumeration Members

bicycling: "bicycling"

requests bicycling directions via bicycle paths & preferred streets (where available).

-
driving: "driving"

(default) indicates standard driving directions using the road network.

-
transit: "transit"

requests directions via public transit routes (where available). +

driving: "driving"

(default) indicates standard driving directions using the road network.

+
transit: "transit"

requests directions via public transit routes (where available). If you set the mode to transit, you can optionally specify either a departure_time or an arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). You can also optionally include a transit_mode and/or a transit_routing_preference.

-
walking: "walking"

requests walking directions via pedestrian paths & sidewalks (where available).

-
\ No newline at end of file +
walking: "walking"

requests walking directions via pedestrian paths & sidewalks (where available).

+
\ No newline at end of file diff --git a/enums/TravelRestriction.html b/enums/TravelRestriction.html index 25a8057037..3963c2c15b 100644 --- a/enums/TravelRestriction.html +++ b/enums/TravelRestriction.html @@ -1,10 +1,10 @@ -TravelRestriction | Google Maps Services Node Client

Enumeration Members

ferries +TravelRestriction | Google Maps Services Node Client

Enumeration Members

Enumeration Members

ferries: "ferries"

indicates that the calculated route should avoid ferries.

-
highways: "highways"

indicates that the calculated route should avoid highways.

-
indoor: "indoor"

indicates that the calculated route should avoid indoor steps for walking and transit directions. +

highways: "highways"

indicates that the calculated route should avoid highways.

+
indoor: "indoor"

indicates that the calculated route should avoid indoor steps for walking and transit directions. Only requests that include an API key or a Google Maps APIs Premium Plan client ID will receive indoor steps by default.

-
tolls: "tolls"

indicates that the calculated route should avoid toll roads/bridges.

-
\ No newline at end of file +
tolls: "tolls"

indicates that the calculated route should avoid toll roads/bridges.

+
\ No newline at end of file diff --git a/enums/UnitSystem.html b/enums/UnitSystem.html index 621720acd2..af8fdf2969 100644 --- a/enums/UnitSystem.html +++ b/enums/UnitSystem.html @@ -1,7 +1,7 @@ UnitSystem | Google Maps Services Node Client

Directions results contain text within distance fields that may be displayed to the user to indicate the distance of a particular "step" of the route. By default, this text uses the unit system of the origin's country or region.

-

Enumeration Members

Enumeration Members

Enumeration Members

imperial: "imperial"

specifies usage of the Imperial (English) system. Textual distances are returned using miles and feet.

-
metric: "metric"

specifies usage of the metric system. Textual distances are returned using kilometers and meters.

-
\ No newline at end of file +
metric: "metric"

specifies usage of the metric system. Textual distances are returned using kilometers and meters.

+
\ No newline at end of file diff --git a/enums/VehicleType.html b/enums/VehicleType.html index b80780366e..7e1db1b4f1 100644 --- a/enums/VehicleType.html +++ b/enums/VehicleType.html @@ -1,5 +1,5 @@ VehicleType | Google Maps Services Node Client

Enumeration Members

BUS +

Enumeration Members

Enumeration Members

BUS: "BUS"

Bus.

-
CABLE_CAR: "CABLE_CAR"

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

-
COMMUTER_TRAIN: "COMMUTER_TRAIN"

Commuter rail.

-
FERRY: "FERRY"

Ferry.

-
FUNICULAR: "FUNICULAR"

A vehicle that is pulled up a steep incline by a cable. +

CABLE_CAR: "CABLE_CAR"

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

+
COMMUTER_TRAIN: "COMMUTER_TRAIN"

Commuter rail.

+
FERRY: "FERRY"

Ferry.

+
FUNICULAR: "FUNICULAR"

A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.

-
GONDOLA_LIFT: "GONDOLA_LIFT"

An aerial cable car.

-
HEAVY_RAIL: "HEAVY_RAIL"

Heavy rail.

-
HIGH_SPEED_TRAIN: "HIGH_SPEED_TRAIN"

High speed train.

-
INTERCITY_BUS: "INTERCITY_BUS"

Intercity bus.

-
METRO_RAIL: "METRO_RAIL"

Light rail transit.

-
MONORAIL: "MONORAIL"

Monorail.

-
OTHER: "OTHER"

All other vehicles will return this type.

-
RAIL: "RAIL"

Rail.

-
SHARE_TAXI: "SHARE_TAXI"

Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.

-
SUBWAY: "SUBWAY"

Underground light rail.

-
TRAM: "TRAM"

Above ground light rail.

-
TROLLEYBUS: "TROLLEYBUS"

Trolleybus.

-
\ No newline at end of file +
GONDOLA_LIFT: "GONDOLA_LIFT"

An aerial cable car.

+
HEAVY_RAIL: "HEAVY_RAIL"

Heavy rail.

+
HIGH_SPEED_TRAIN: "HIGH_SPEED_TRAIN"

High speed train.

+
INTERCITY_BUS: "INTERCITY_BUS"

Intercity bus.

+
METRO_RAIL: "METRO_RAIL"

Light rail transit.

+
MONORAIL: "MONORAIL"

Monorail.

+
OTHER: "OTHER"

All other vehicles will return this type.

+
RAIL: "RAIL"

Rail.

+
SHARE_TAXI: "SHARE_TAXI"

Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.

+
SUBWAY: "SUBWAY"

Underground light rail.

+
TRAM: "TRAM"

Above ground light rail.

+
TROLLEYBUS: "TROLLEYBUS"

Trolleybus.

+
\ No newline at end of file diff --git a/functions/defaultAxiosInstance.html b/functions/defaultAxiosInstance.html index 0e561bfa81..3002c00763 100644 --- a/functions/defaultAxiosInstance.html +++ b/functions/defaultAxiosInstance.html @@ -1 +1 @@ -defaultAxiosInstance | Google Maps Services Node Client
  • Type Parameters

    • T = any
    • R = AxiosResponse<T, any>
    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T, any>
    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

\ No newline at end of file +defaultAxiosInstance | Google Maps Services Node Client
  • Type Parameters

    • T = any
    • R = AxiosResponse<T, any>
    • D = any

    Parameters

    • config: AxiosRequestConfig<D>

    Returns Promise<R>

  • Type Parameters

    • T = any
    • R = AxiosResponse<T, any>
    • D = any

    Parameters

    • url: string
    • Optional config: AxiosRequestConfig<D>

    Returns Promise<R>

\ No newline at end of file diff --git a/interfaces/AddressComponent.html b/interfaces/AddressComponent.html index 83c88f1977..63fe28a0a0 100644 --- a/interfaces/AddressComponent.html +++ b/interfaces/AddressComponent.html @@ -1,9 +1,9 @@ -AddressComponent | Google Maps Services Node Client
interface AddressComponent {
    long_name: string;
    short_name: string;
    types: (AddressType | GeocodingAddressComponentType)[];
}

Properties

long_name +AddressComponent | Google Maps Services Node Client
interface AddressComponent {
    long_name: string;
    short_name: string;
    types: (AddressType | GeocodingAddressComponentType)[];
}

Properties

long_name: string

is the full text description or name of the address component as returned by the Geocoder.

-
short_name: string

is an abbreviated textual name for the address component, if available. +

short_name: string

is an abbreviated textual name for the address component, if available. For example, an address component for the state of Alaska may have a long_name of "Alaska" and a short_name of "AK" using the 2-letter postal abbreviation.

-

is an array indicating the type of the address component.

-
\ No newline at end of file +

is an array indicating the type of the address component.

+
\ No newline at end of file diff --git a/interfaces/AddressDescriptor.html b/interfaces/AddressDescriptor.html index 3860f622d5..48d294181b 100644 --- a/interfaces/AddressDescriptor.html +++ b/interfaces/AddressDescriptor.html @@ -1,6 +1,6 @@ AddressDescriptor | Google Maps Services Node Client

Represents a descriptor of an address.

Please see Address -Descriptors for more detail.

interface AddressDescriptor {
    areas: Area[];
    landmarks: Landmark[];
}

Properties

areas +Descriptors for more detail.
interface AddressDescriptor {
    areas: Area[];
    landmarks: Landmark[];
}

Properties

Properties

areas: Area[]
landmarks: Landmark[]
\ No newline at end of file +

Properties

areas: Area[]
landmarks: Landmark[]
\ No newline at end of file diff --git a/interfaces/AddressGeometry.html b/interfaces/AddressGeometry.html index d42f5ccd26..7e8666a908 100644 --- a/interfaces/AddressGeometry.html +++ b/interfaces/AddressGeometry.html @@ -1,4 +1,4 @@ -AddressGeometry | Google Maps Services Node Client
interface AddressGeometry {
    bounds?: LatLngBounds;
    location: LatLngLiteral;
    location_type?: LocationType;
    viewport: LatLngBounds;
}

Properties

bounds? +AddressGeometry | Google Maps Services Node Client
interface AddressGeometry {
    bounds?: LatLngBounds;
    location: LatLngLiteral;
    location_type?: LocationType;
    viewport: LatLngBounds;
}

Properties

bounds? location location_type? viewport @@ -6,9 +6,9 @@ Note that these bounds may not match the recommended viewport. (For example, San Francisco includes the Farallon islands, which are technically part of the city, but probably should not be returned in the viewport.)

-
location: LatLngLiteral

contains the geocoded latitude, longitude value. For normal address lookups, this field is typically the most important.

-
location_type?: LocationType

stores additional data about the specified location.

-
viewport: LatLngBounds

contains the recommended viewport for displaying the returned result, specified as two latitude, longitude values +

location: LatLngLiteral

contains the geocoded latitude, longitude value. For normal address lookups, this field is typically the most important.

+
location_type?: LocationType

stores additional data about the specified location.

+
viewport: LatLngBounds

contains the recommended viewport for displaying the returned result, specified as two latitude, longitude values defining the southwest and northeast corner of the viewport bounding box. Generally the viewport is used to frame a result when displaying it to a user.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/AlternativePlaceId.html b/interfaces/AlternativePlaceId.html index 8e8a55dd14..995e837166 100644 --- a/interfaces/AlternativePlaceId.html +++ b/interfaces/AlternativePlaceId.html @@ -1,7 +1,7 @@ -AlternativePlaceId | Google Maps Services Node Client
interface AlternativePlaceId {
    place_id: string;
    scope: "APP";
}

Properties

place_id +AlternativePlaceId | Google Maps Services Node Client
interface AlternativePlaceId {
    place_id: string;
    scope: "APP";
}

Properties

Properties

place_id: string

The most likely reason for a place to have an alternative place ID is if your application adds a place and receives an application-scoped place ID, then later receives a Google-scoped place ID after passing the moderation process.

-
scope: "APP"

The scope of an alternative place ID will always be APP, +

scope: "APP"

The scope of an alternative place ID will always be APP, indicating that the alternative place ID is recognised by your application only.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/ApiKeyParams.html b/interfaces/ApiKeyParams.html index 88f81d680e..df574ccd4e 100644 --- a/interfaces/ApiKeyParams.html +++ b/interfaces/ApiKeyParams.html @@ -1,4 +1,4 @@ -ApiKeyParams | Google Maps Services Node Client
interface ApiKeyParams {
    key: string;
}

Properties

key +ApiKeyParams | Google Maps Services Node Client
interface ApiKeyParams {
    key: string;
}

Properties

Properties

key: string

You must include an API key with every API request. We strongly recommend that you restrict your API key. Restrictions provide added security and help ensure only authorized requests are made with your API key.

There are two restrictions. You should set both:

@@ -8,4 +8,4 @@

API restriction: Limits usage of the API key to one or more APIs or SDKs. Requests to an API or SDK associated with the API key will be processed. Requests to an API or SDK not associated with the API key will fail.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/AspectRating.html b/interfaces/AspectRating.html index 79b08de2d6..6acc80a386 100644 --- a/interfaces/AspectRating.html +++ b/interfaces/AspectRating.html @@ -1,5 +1,5 @@ -AspectRating | Google Maps Services Node Client
interface AspectRating {
    rating: number;
    type: AspectRatingType;
}

Properties

rating +AspectRating | Google Maps Services Node Client
interface AspectRating {
    rating: number;
    type: AspectRatingType;
}

Properties

Properties

rating: number

the user's rating for this particular aspect, from 0 to 3.

-

the name of the aspect that is being rated.

-
\ No newline at end of file +

the name of the aspect that is being rated.

+
\ No newline at end of file diff --git a/interfaces/CellTower.html b/interfaces/CellTower.html index e067f82b46..9f1ddfdced 100644 --- a/interfaces/CellTower.html +++ b/interfaces/CellTower.html @@ -1,4 +1,4 @@ -CellTower | Google Maps Services Node Client
interface CellTower {
    age?: number;
    cellId: number;
    locationAreaCode: number;
    mobileCountryCode: number;
    mobileNetworkCode: number;
    signalStrength?: number;
    timingAdvance?: number;
}

Properties

age? +CellTower | Google Maps Services Node Client
interface CellTower {
    age?: number;
    cellId: number;
    locationAreaCode: number;
    mobileCountryCode: number;
    mobileNetworkCode: number;
    signalStrength?: number;
    timingAdvance?: number;
}

Properties

age?: number

The number of milliseconds since this cell was primary. If age is 0, the cellId represents a current measurement.

-
cellId: number

Unique identifier of the cell. +

cellId: number

Unique identifier of the cell. On GSM, this is the Cell ID (CID); CDMA networks use the Base Station ID (BID). WCDMA networks use the UTRAN/GERAN Cell Identity (UC-Id), which is a 32-bit value concatenating the Radio Network Controller (RNC) and Cell ID. Specifying only the 16-bit Cell ID value in WCDMA networks may return inaccurate results.

-
locationAreaCode: number

The Location Area Code (LAC) for GSM and WCDMA networks. The Network ID (NID) for CDMA networks.

-
mobileCountryCode: number

The cell tower's Mobile Country Code (MCC).

-
mobileNetworkCode: number

The cell tower's Mobile Network Code. This is the MNC for GSM and WCDMA; CDMA uses the System ID (SID).

-
signalStrength?: number

Radio signal strength measured in dBm.

-
timingAdvance?: number

The timing advance value.

-
\ No newline at end of file +
locationAreaCode: number

The Location Area Code (LAC) for GSM and WCDMA networks. The Network ID (NID) for CDMA networks.

+
mobileCountryCode: number

The cell tower's Mobile Country Code (MCC).

+
mobileNetworkCode: number

The cell tower's Mobile Network Code. This is the MNC for GSM and WCDMA; CDMA uses the System ID (SID).

+
signalStrength?: number

Radio signal strength measured in dBm.

+
timingAdvance?: number

The timing advance value.

+
\ No newline at end of file diff --git a/interfaces/ClientOptions.html b/interfaces/ClientOptions.html index 26db001e82..b7e27fcfc9 100644 --- a/interfaces/ClientOptions.html +++ b/interfaces/ClientOptions.html @@ -1,6 +1,6 @@ -ClientOptions | Google Maps Services Node Client
interface ClientOptions {
    axiosInstance?: AxiosInstance;
    config?: Config;
    experienceId?: string[];
}

Properties

axiosInstance? +ClientOptions | Google Maps Services Node Client
interface ClientOptions {
    axiosInstance?: AxiosInstance;
    config?: Config;
    experienceId?: string[];
}

Properties

axiosInstance?: AxiosInstance

AxiosInstance to be used by client. Provide one of axiosInstance or config.

-
config?: Config

Config used to create AxiosInstance. Provide one of axiosInstance or config.

-
experienceId?: string[]
\ No newline at end of file +
config?: Config

Config used to create AxiosInstance. Provide one of axiosInstance or config.

+
experienceId?: string[]
\ No newline at end of file diff --git a/interfaces/DirectionsRequest.html b/interfaces/DirectionsRequest.html index 669635d073..dc12a4fc06 100644 --- a/interfaces/DirectionsRequest.html +++ b/interfaces/DirectionsRequest.html @@ -1,4 +1,4 @@ -DirectionsRequest | Google Maps Services Node Client
interface DirectionsRequest {
    params: {
        alternatives?: boolean;
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date | "now";
        destination: LatLng;
        language?: Language;
        mode?: TravelMode;
        optimize?: boolean;
        origin: LatLng;
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
        waypoints?: LatLng[];
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DirectionsRequest

Properties

params +DirectionsRequest | Google Maps Services Node Client
interface DirectionsRequest {
    params: {
        alternatives?: boolean;
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date | "now";
        destination: LatLng;
        language?: Language;
        mode?: TravelMode;
        optimize?: boolean;
        origin: LatLng;
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
        waypoints?: LatLng[];
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DirectionsRequest

Properties

Properties

params: {
    alternatives?: boolean;
    arrival_time?: number | Date;
    avoid?: TravelRestriction[];
    departure_time?: number | Date | "now";
    destination: LatLng;
    language?: Language;
    mode?: TravelMode;
    optimize?: boolean;
    origin: LatLng;
    region?: string;
    traffic_model?: TrafficModel;
    transit_mode?: TransitMode[];
    transit_routing_preference?: TransitRoutingPreference;
    units?: UnitSystem;
    waypoints?: LatLng[];
} & RequestParams

Type declaration

  • Optional alternatives?: boolean

    If set to true, specifies that the Directions service may provide more than one route alternative in the response. Note that providing route alternatives may increase the response time from the server.

  • Optional arrival_time?: number | Date

    Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC. @@ -78,4 +78,4 @@ Encoded polylines must be prefixed with enc: and followed by a colon (:). Place IDs must be prefixed with place_id:. The place ID may only be specified if the request includes an API key or a Google Maps APIs Premium Plan client ID. Waypoints are only supported for driving, walking and bicycling directions.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/DirectionsResponse.html b/interfaces/DirectionsResponse.html index 03427b4bdb..01316989ce 100644 --- a/interfaces/DirectionsResponse.html +++ b/interfaces/DirectionsResponse.html @@ -1,2 +1,2 @@ -DirectionsResponse | Google Maps Services Node Client
interface DirectionsResponse {
    data: DirectionsResponseData;
}

Hierarchy

  • AxiosResponse
    • DirectionsResponse

Properties

Properties

\ No newline at end of file +DirectionsResponse | Google Maps Services Node Client
interface DirectionsResponse {
    data: DirectionsResponseData;
}

Hierarchy

  • AxiosResponse
    • DirectionsResponse

Properties

Properties

\ No newline at end of file diff --git a/interfaces/DirectionsResponseData.html b/interfaces/DirectionsResponseData.html index b57edd1edf..f047b9bb16 100644 --- a/interfaces/DirectionsResponseData.html +++ b/interfaces/DirectionsResponseData.html @@ -1,4 +1,4 @@ -DirectionsResponseData | Google Maps Services Node Client
interface DirectionsResponseData {
    available_travel_modes: string[];
    error_message: string;
    geocoded_waypoints: GeocodedWaypoint[];
    html_attributions?: string[];
    next_page_token?: string;
    routes: DirectionsRoute[];
    status: Status;
}

Hierarchy (view full)

Properties

available_travel_modes +DirectionsResponseData | Google Maps Services Node Client
interface DirectionsResponseData {
    available_travel_modes: string[];
    error_message: string;
    geocoded_waypoints: GeocodedWaypoint[];
    html_attributions?: string[];
    next_page_token?: string;
    routes: DirectionsRoute[];
    status: Status;
}

Hierarchy (view full)

Properties

available_travel_modes: string[]

contains an array of available travel modes. This field is returned when a request specifies a travel mode and gets no results. The array contains the available travel modes in the countries of the given set of waypoints. This field is not returned if one or more of the waypoints are via: waypoints.

-
error_message: string

When the top-level status code is other than OK, this field contains more detailed information +

error_message: string

When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

-
geocoded_waypoints: GeocodedWaypoint[]

contains an array with details about the geocoding of origin, destination and waypoints.

+
geocoded_waypoints: GeocodedWaypoint[]

contains an array with details about the geocoding of origin, destination and waypoints.

These details will not be present for waypoints specified as textual latitude/longitude values if the service returns no results. This is because such waypoints are only reverse geocoded to obtain their representative address after a route has been found. An empty JSON object will occupy the corresponding places in the geocoded_waypoints array.

-
html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

-
next_page_token?: string

contains a token that can be used to return up to 20 additional results. +

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

+
next_page_token?: string

contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

-
routes: DirectionsRoute[]

contains an array of routes from the origin to the destination.

+
routes: DirectionsRoute[]

contains an array of routes from the origin to the destination.

When the Directions API returns results, it places them within a (JSON) routes array. Even if the service returns no results (such as if the origin and/or destination doesn't exist) it still returns an empty routes array. (XML responses consist of zero or more <route> elements.)

@@ -27,5 +27,5 @@ This route may consist of one or more legs depending on whether any waypoints were specified. As well, the route also contains copyright and warning information which must be displayed to the user in addition to the routing information.

-
status: Status

contains metadata on the request. See Status Codes below.

-
\ No newline at end of file +
status: Status

contains metadata on the request. See Status Codes below.

+
\ No newline at end of file diff --git a/interfaces/DirectionsRoute.html b/interfaces/DirectionsRoute.html index 4a7709cef4..75bf1a1df6 100644 --- a/interfaces/DirectionsRoute.html +++ b/interfaces/DirectionsRoute.html @@ -1,6 +1,6 @@ DirectionsRoute | Google Maps Services Node Client

This route may consist of one or more legs depending on whether any waypoints were specified. As well, the route also contains copyright and warning information which must be displayed to the user in addition to the routing information.

-
interface DirectionsRoute {
    bounds: LatLngBounds;
    copyrights: string;
    fare: TransitFare;
    legs: RouteLeg[];
    overview_path: LatLngLiteral[];
    overview_polyline: {
        points: string;
    };
    summary: string;
    warnings: string[];
    waypoint_order: number[];
}

Properties

interface DirectionsRoute {
    bounds: LatLngBounds;
    copyrights: string;
    fare: TransitFare;
    legs: RouteLeg[];
    overview_path: LatLngLiteral[];
    overview_polyline: {
        points: string;
    };
    summary: string;
    warnings: string[];
    waypoint_order: number[];
}

Properties

Properties

bounds: LatLngBounds

contains the viewport bounding box of the overview_polyline.

-
copyrights: string

contains the copyrights text to be displayed for this route. You must handle and display this information yourself.

-

If present, contains the total fare (that is, the total ticket costs) on this route. +

copyrights: string

contains the copyrights text to be displayed for this route. You must handle and display this information yourself.

+

If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for routes where fare information is available for all transit legs.

Note: The Directions API only returns fare information for requests that contain either an API key or a client ID and digital signature.

-
legs: RouteLeg[]

contains an array which contains information about a leg of the route, between two locations within the given route. +

legs: RouteLeg[]

contains an array which contains information about a leg of the route, between two locations within the given route. A separate leg will be present for each waypoint or destination specified. (A route with no waypoints will contain exactly one leg within the legs array.) Each leg consists of a series of steps.

-
overview_path: LatLngLiteral[]

An array of LatLngs representing the entire course of this route. The path is simplified in order to make +

overview_path: LatLngLiteral[]

An array of LatLngs representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).

-
overview_polyline: {
    points: string;
}

contains a single points object that holds an encoded polyline representation of the route. +

overview_polyline: {
    points: string;
}

contains a single points object that holds an encoded polyline representation of the route. This polyline is an approximate (smoothed) path of the resulting directions.

-

Type declaration

  • points: string
summary: string

contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.

-
warnings: string[]

contains an array of warnings to be displayed when showing these directions. You must handle and display these warnings yourself.

-
waypoint_order: number[]

contains an array indicating the order of any waypoints in the calculated route. +

Type declaration

  • points: string
summary: string

contains a short textual description for the route, suitable for naming and disambiguating the route from alternatives.

+
warnings: string[]

contains an array of warnings to be displayed when showing these directions. You must handle and display these warnings yourself.

+
waypoint_order: number[]

contains an array indicating the order of any waypoints in the calculated route. This waypoints may be reordered if the request was passed optimize:true within its waypoints parameter.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/DirectionsStep.html b/interfaces/DirectionsStep.html index 9dbb9983d5..72fd4d9601 100644 --- a/interfaces/DirectionsStep.html +++ b/interfaces/DirectionsStep.html @@ -7,7 +7,7 @@ driving steps in an inner steps array. For example, a walking step will include directions from the start and end locations: "Walk to Innes Ave & Fitch St". That step will include detailed walking directions for that route in the inner steps array, such as: "Head north-west", "Turn left onto Arelious Walker", and "Turn left onto Innes Ave".

-
interface DirectionsStep {
    distance: Distance;
    duration: Duration;
    end_location: LatLngLiteral;
    html_instructions: string;
    maneuver: Maneuver;
    polyline: {
        points: string;
    };
    start_location: LatLngLiteral;
    steps: DirectionsStep;
    transit_details: TransitDetails;
    travel_mode: TravelMode;
}

Properties

interface DirectionsStep {
    distance: Distance;
    duration: Duration;
    end_location: LatLngLiteral;
    html_instructions: string;
    maneuver: Maneuver;
    polyline: {
        points: string;
    };
    start_location: LatLngLiteral;
    steps: DirectionsStep;
    transit_details: TransitDetails;
    travel_mode: TravelMode;
}

Properties

distance: Distance

contains the distance covered by this step until the next step. (See the discussion of this field in Directions Legs)

This field may be undefined if the distance is unknown.

-
duration: Duration

contains the typical time required to perform the step, until the next step. (See the description in Directions Legs)

+
duration: Duration

contains the typical time required to perform the step, until the next step. (See the description in Directions Legs)

This field may be undefined if the duration is unknown

-
end_location: LatLngLiteral

contains the location of the last point of this step, as a single set of lat and lng fields.

-
html_instructions: string

contains formatted instructions for this step, presented as an HTML text string.

-
maneuver: Maneuver

contains the action to take for the current step (turn left, merge, straight, etc.). +

end_location: LatLngLiteral

contains the location of the last point of this step, as a single set of lat and lng fields.

+
html_instructions: string

contains formatted instructions for this step, presented as an HTML text string.

+
maneuver: Maneuver

contains the action to take for the current step (turn left, merge, straight, etc.). This field is used to determine which icon to display.

-
polyline: {
    points: string;
}

contains a single points object that holds an encoded polyline representation of the step. +

polyline: {
    points: string;
}

contains a single points object that holds an encoded polyline representation of the step. This polyline is an approximate (smoothed) path of the step.

-

Type declaration

  • points: string
start_location: LatLngLiteral

contains the location of the starting point of this step, as a single set of lat and lng fields.

-

contains detailed directions for walking or driving steps in transit directions. +

Type declaration

  • points: string
start_location: LatLngLiteral

contains the location of the starting point of this step, as a single set of lat and lng fields.

+

contains detailed directions for walking or driving steps in transit directions. Substeps are only available when travel_mode is set to "transit". The inner steps array is of the same type as steps.

-
transit_details: TransitDetails

contains transit specific information. This field is only returned with travel_mode is set to "transit".

-
travel_mode: TravelMode

contains the type of travel mode used.

-
\ No newline at end of file +
transit_details: TransitDetails

contains transit specific information. This field is only returned with travel_mode is set to "transit".

+
travel_mode: TravelMode

contains the type of travel mode used.

+
\ No newline at end of file diff --git a/interfaces/Distance.html b/interfaces/Distance.html index a0e22bd14f..995b904f2a 100644 --- a/interfaces/Distance.html +++ b/interfaces/Distance.html @@ -1,7 +1,7 @@ -Distance | Google Maps Services Node Client
interface Distance {
    text: string;
    value: number;
}

Properties

text +Distance | Google Maps Services Node Client
interface Distance {
    text: string;
    value: number;
}

Properties

Properties

text: string

contains a human-readable representation of the distance, displayed in units as used at the origin (or as overridden within the units parameter in the request). (For example, miles and feet will be used for any origin within the United States.)

-
value: number

indicates the distance in meters.

-
\ No newline at end of file +
value: number

indicates the distance in meters.

+
\ No newline at end of file diff --git a/interfaces/DistanceMatrixRequest.html b/interfaces/DistanceMatrixRequest.html index 33ee22b4fb..cf3c4be2c5 100644 --- a/interfaces/DistanceMatrixRequest.html +++ b/interfaces/DistanceMatrixRequest.html @@ -1,4 +1,4 @@ -DistanceMatrixRequest | Google Maps Services Node Client
interface DistanceMatrixRequest {
    params: {
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date;
        destinations: LatLng[];
        language?: string;
        mode?: TravelMode;
        origins: LatLng[];
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DistanceMatrixRequest

Properties

params +DistanceMatrixRequest | Google Maps Services Node Client
interface DistanceMatrixRequest {
    params: {
        arrival_time?: number | Date;
        avoid?: TravelRestriction[];
        departure_time?: number | Date;
        destinations: LatLng[];
        language?: string;
        mode?: TravelMode;
        origins: LatLng[];
        region?: string;
        traffic_model?: TrafficModel;
        transit_mode?: TransitMode[];
        transit_routing_preference?: TransitRoutingPreference;
        units?: UnitSystem;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • DistanceMatrixRequest

Properties

Properties

params: {
    arrival_time?: number | Date;
    avoid?: TravelRestriction[];
    departure_time?: number | Date;
    destinations: LatLng[];
    language?: string;
    mode?: TravelMode;
    origins: LatLng[];
    region?: string;
    traffic_model?: TrafficModel;
    transit_mode?: TransitMode[];
    transit_routing_preference?: TransitRoutingPreference;
    units?: UnitSystem;
} & RequestParams

Type declaration

  • Optional arrival_time?: number | Date

    Specifies the desired time of arrival for transit requests, in seconds since midnight, January 1, 1970 UTC. You can specify either departure_time or arrival_time, but not both. Note that arrival_time must be specified as an integer.

    @@ -85,4 +85,4 @@ rather than accepting the default best route chosen by the API. This parameter may only be specified for requests where the mode is transit.

  • Optional units?: UnitSystem

    Specifies the unit system to use when expressing distance as text.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/interfaces/DistanceMatrixResponse.html b/interfaces/DistanceMatrixResponse.html index 64a744e8ac..903125c931 100644 --- a/interfaces/DistanceMatrixResponse.html +++ b/interfaces/DistanceMatrixResponse.html @@ -1,2 +1,2 @@ -DistanceMatrixResponse | Google Maps Services Node Client
interface DistanceMatrixResponse {
    data: DistanceMatrixResponseData;
}

Hierarchy

  • AxiosResponse
    • DistanceMatrixResponse

Properties

Properties

\ No newline at end of file +DistanceMatrixResponse | Google Maps Services Node Client
interface DistanceMatrixResponse {
    data: DistanceMatrixResponseData;
}

Hierarchy

  • AxiosResponse
    • DistanceMatrixResponse

Properties

Properties

\ No newline at end of file diff --git a/interfaces/DistanceMatrixResponseData.html b/interfaces/DistanceMatrixResponseData.html index 4e1bb458ba..8e85b5b1d5 100644 --- a/interfaces/DistanceMatrixResponseData.html +++ b/interfaces/DistanceMatrixResponseData.html @@ -1,4 +1,4 @@ -DistanceMatrixResponseData | Google Maps Services Node Client
interface DistanceMatrixResponseData {
    destination_addresses: string[];
    error_message: string;
    html_attributions?: string[];
    next_page_token?: string;
    origin_addresses: string[];
    rows: DistanceMatrixRow[];
    status: Status;
}

Hierarchy (view full)

Properties

destination_addresses +DistanceMatrixResponseData | Google Maps Services Node Client
interface DistanceMatrixResponseData {
    destination_addresses: string[];
    error_message: string;
    html_attributions?: string[];
    next_page_token?: string;
    origin_addresses: string[];
    rows: DistanceMatrixRow[];
    status: Status;
}

Hierarchy (view full)

Properties

destination_addresses: string[]

contains an array of addresses as returned by the API from your original request. As with origin_addresses, these are localized if appropriate.

-
error_message: string

When the top-level status code is other than OK, this field contains more detailed information +

error_message: string

When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

-
html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

-
next_page_token?: string

contains a token that can be used to return up to 20 additional results. +

html_attributions?: string[]

may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

+
next_page_token?: string

contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

-
origin_addresses: string[]

contains an array of elements, which in turn each contain a status, duration, and distance element.

-
status: Status

contains metadata on the request. See Status Codes below.

-
\ No newline at end of file +
origin_addresses: string[]

contains an array of elements, which in turn each contain a status, duration, and distance element.

+
status: Status

contains metadata on the request. See Status Codes below.

+
\ No newline at end of file diff --git a/interfaces/DistanceMatrixRow.html b/interfaces/DistanceMatrixRow.html index 5872bd570e..acd754a293 100644 --- a/interfaces/DistanceMatrixRow.html +++ b/interfaces/DistanceMatrixRow.html @@ -4,5 +4,5 @@

Rows are ordered according to the values in the origin parameter of the request. Each row corresponds to an origin, and each element within that row corresponds to a pairing of the origin with a destination value.

Each row array contains one or more element entries, which in turn contain the information about a single origin-destination pairing.

-
interface DistanceMatrixRow {
    elements: DistanceMatrixRowElement[];
}

Properties

Properties

\ No newline at end of file +
interface DistanceMatrixRow {
    elements: DistanceMatrixRowElement[];
}

Properties

Properties

\ No newline at end of file diff --git a/interfaces/DistanceMatrixRowElement.html b/interfaces/DistanceMatrixRowElement.html index bea517d5bf..c348c6f9d9 100644 --- a/interfaces/DistanceMatrixRowElement.html +++ b/interfaces/DistanceMatrixRowElement.html @@ -1,14 +1,14 @@ DistanceMatrixRowElement | Google Maps Services Node Client

The information about each origin-destination pairing is returned in an element entry.

-
interface DistanceMatrixRowElement {
    distance: Distance;
    duration: Duration;
    duration_in_traffic: Duration;
    fare: TransitFare;
    status: Status;
}

Properties

interface DistanceMatrixRowElement {
    distance: Distance;
    duration: Duration;
    duration_in_traffic: Duration;
    fare: TransitFare;
    status: Status;
}

Properties

distance: Distance

The total distance of this route, expressed in meters (value) and as text. The textual value uses the unit system specified with the unit parameter of the original request, or the origin's region.

-
duration: Duration

The length of time it takes to travel this route, expressed in seconds (the value field) and as text. +

duration: Duration

The length of time it takes to travel this route, expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter.

-
duration_in_traffic: Duration

The length of time it takes to travel this route, based on current and historical traffic conditions. +

duration_in_traffic: Duration

The length of time it takes to travel this route, based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration is expressed in seconds (the value field) and as text. The textual representation is localized according to the query's language parameter. @@ -19,7 +19,7 @@

  • Traffic conditions are available for the requested route.
  • The mode parameter is set to driving.
  • -

    If present, contains the total fare (that is, the total ticket costs) on this route. +

    If present, contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for transit providers where fare information is available.

    -
    status: Status

    possible status codes

    -
    \ No newline at end of file +
    status: Status

    possible status codes

    +
    \ No newline at end of file diff --git a/interfaces/Duration.html b/interfaces/Duration.html index 7a6c9bc87c..95448a43ea 100644 --- a/interfaces/Duration.html +++ b/interfaces/Duration.html @@ -1,5 +1,5 @@ -Duration | Google Maps Services Node Client
    interface Duration {
        text: string;
        value: number;
    }

    Properties

    text +Duration | Google Maps Services Node Client
    interface Duration {
        text: string;
        value: number;
    }

    Properties

    Properties

    text: string

    contains a human-readable representation of the duration.

    -
    value: number

    indicates the duration in seconds.

    -
    \ No newline at end of file +
    value: number

    indicates the duration in seconds.

    +
    \ No newline at end of file diff --git a/interfaces/ElevationRequest.html b/interfaces/ElevationRequest.html index cea3fc89cb..45f2c56067 100644 --- a/interfaces/ElevationRequest.html +++ b/interfaces/ElevationRequest.html @@ -1,2 +1,2 @@ -ElevationRequest | Google Maps Services Node Client
    interface ElevationRequest {
        params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ElevationRequest

    Properties

    Properties

    \ No newline at end of file +ElevationRequest | Google Maps Services Node Client
    interface ElevationRequest {
        params: (PositionalElevationParams | SampledPathElevationParams) & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ElevationRequest

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/ElevationResponse.html b/interfaces/ElevationResponse.html index 39c4d06663..37c3085bd5 100644 --- a/interfaces/ElevationResponse.html +++ b/interfaces/ElevationResponse.html @@ -1,2 +1,2 @@ -ElevationResponse | Google Maps Services Node Client
    interface ElevationResponse {
        data: ElevationResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ElevationResponse

    Properties

    Properties

    \ No newline at end of file +ElevationResponse | Google Maps Services Node Client
    interface ElevationResponse {
        data: ElevationResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ElevationResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/ElevationResponseData.html b/interfaces/ElevationResponseData.html index 0ec0da732e..76f079955b 100644 --- a/interfaces/ElevationResponseData.html +++ b/interfaces/ElevationResponseData.html @@ -1,21 +1,21 @@ -ElevationResponseData | Google Maps Services Node Client
    interface ElevationResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: {
            elevation: number;
            location: LatLngLiteral;
            resolution: number;
        }[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +ElevationResponseData | Google Maps Services Node Client
    interface ElevationResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: {
            elevation: number;
            location: LatLngLiteral;
            resolution: number;
        }[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    results: {
        elevation: number;
        location: LatLngLiteral;
        resolution: number;
    }[]

    Type declaration

    results: {
        elevation: number;
        location: LatLngLiteral;
        resolution: number;
    }[]

    Type declaration

    • elevation: number

      An elevation element indicating the elevation of the location in meters.

    • location: LatLngLiteral

      A location element (containing lat and lng elements) of the position for which elevation data is being computed. Note that for path requests, the set of location elements will contain the sampled points along the path.

    • resolution: number

      A resolution value, indicating the maximum distance between data points from which the elevation was interpolated, in meters. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently.

      -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/FindPlaceFromTextRequest.html b/interfaces/FindPlaceFromTextRequest.html index e7f627763f..2b176da43b 100644 --- a/interfaces/FindPlaceFromTextRequest.html +++ b/interfaces/FindPlaceFromTextRequest.html @@ -1,4 +1,4 @@ -FindPlaceFromTextRequest | Google Maps Services Node Client
    interface FindPlaceFromTextRequest {
        params: {
            fields?: string[];
            input: string;
            inputtype: PlaceInputType;
            language?: Language;
            locationbias?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • FindPlaceFromTextRequest

    Properties

    params +FindPlaceFromTextRequest | Google Maps Services Node Client
    interface FindPlaceFromTextRequest {
        params: {
            fields?: string[];
            input: string;
            inputtype: PlaceInputType;
            language?: Language;
            locationbias?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • FindPlaceFromTextRequest

    Properties

    Properties

    params: {
        fields?: string[];
        input: string;
        inputtype: PlaceInputType;
        language?: Language;
        locationbias?: string;
    } & RequestParams

    Type declaration

    • Optional fields?: string[]

      The fields specifying the types of place data to return.

      Note: If you omit the fields parameter from a Find Place request, only the place_id for the result will be returned.

    • input: string

      The text input specifying which place to search for (for example, a name, address, or phone number).

      @@ -7,4 +7,4 @@ Searches are also biased to the selected language; results in the selected language may be given a higher ranking

    • Optional locationbias?: string

      Prefer results in a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. If this parameter is not specified, the API uses IP address biasing by default.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/FindPlaceFromTextResponse.html b/interfaces/FindPlaceFromTextResponse.html index 65dd8a256b..6f164e5851 100644 --- a/interfaces/FindPlaceFromTextResponse.html +++ b/interfaces/FindPlaceFromTextResponse.html @@ -1,2 +1,2 @@ -FindPlaceFromTextResponse | Google Maps Services Node Client
    interface FindPlaceFromTextResponse {
        data: FindPlaceFromTextResponseData;
    }

    Hierarchy

    • AxiosResponse
      • FindPlaceFromTextResponse

    Properties

    Properties

    \ No newline at end of file +FindPlaceFromTextResponse | Google Maps Services Node Client
    interface FindPlaceFromTextResponse {
        data: FindPlaceFromTextResponseData;
    }

    Hierarchy

    • AxiosResponse
      • FindPlaceFromTextResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/FindPlaceFromTextResponseData.html b/interfaces/FindPlaceFromTextResponseData.html index c13e74d3ba..230f551f1e 100644 --- a/interfaces/FindPlaceFromTextResponseData.html +++ b/interfaces/FindPlaceFromTextResponseData.html @@ -1,14 +1,14 @@ -FindPlaceFromTextResponseData | Google Maps Services Node Client
    interface FindPlaceFromTextResponseData {
        candidates: Partial<PlaceData>[];
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    candidates +FindPlaceFromTextResponseData | Google Maps Services Node Client
    interface FindPlaceFromTextResponseData {
        candidates: Partial<PlaceData>[];
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    candidates: Partial<PlaceData>[]
    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    Properties

    candidates: Partial<PlaceData>[]
    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/GeocodeComponents.html b/interfaces/GeocodeComponents.html index 03a5b0cefa..ac5cff18d9 100644 --- a/interfaces/GeocodeComponents.html +++ b/interfaces/GeocodeComponents.html @@ -1,13 +1,13 @@ -GeocodeComponents | Google Maps Services Node Client
    interface GeocodeComponents {
        administrative_area?: string;
        country?: string;
        locality?: string;
        postal_code?: string;
        route?: string;
    }

    Properties

    administrative_area? +GeocodeComponents | Google Maps Services Node Client
    interface GeocodeComponents {
        administrative_area?: string;
        country?: string;
        locality?: string;
        postal_code?: string;
        route?: string;
    }

    Properties

    administrative_area?: string

    matches all the administrative_area levels.

    -
    country?: string

    matches a country name or a two letter ISO 3166-1 country code. +

    country?: string

    matches a country name or a two letter ISO 3166-1 country code. Note: The API follows the ISO standard for defining countries, and the filtering works best when using the corresponding ISO code of the country

    -
    locality?: string

    matches against locality and sublocality types.

    -
    postal_code?: string

    matches postal_code and postal_code_prefix.

    -
    route?: string

    matches the long or short name of a route.

    -
    \ No newline at end of file +
    locality?: string

    matches against locality and sublocality types.

    +
    postal_code?: string

    matches postal_code and postal_code_prefix.

    +
    route?: string

    matches the long or short name of a route.

    +
    \ No newline at end of file diff --git a/interfaces/GeocodeRequest.html b/interfaces/GeocodeRequest.html index d27ec01d5e..1d8dde9592 100644 --- a/interfaces/GeocodeRequest.html +++ b/interfaces/GeocodeRequest.html @@ -1,4 +1,4 @@ -GeocodeRequest | Google Maps Services Node Client
    interface GeocodeRequest {
        params: {
            address?: string;
            bounds?: string | LatLngBounds;
            components?: string | GeocodeComponents;
            language?: string;
            place_id?: string;
            region?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeocodeRequest

    Properties

    params +GeocodeRequest | Google Maps Services Node Client
    interface GeocodeRequest {
        params: {
            address?: string;
            bounds?: string | LatLngBounds;
            components?: string | GeocodeComponents;
            language?: string;
            place_id?: string;
            region?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeocodeRequest

    Properties

    Properties

    params: {
        address?: string;
        bounds?: string | LatLngBounds;
        components?: string | GeocodeComponents;
        language?: string;
        place_id?: string;
        region?: string;
    } & RequestParams

    Type declaration

    • Optional address?: string

      The street address that you want to geocode, in the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided.

    • Optional bounds?: string | LatLngBounds

      The bounding box of the viewport within which to bias geocode results more prominently. @@ -23,4 +23,4 @@

    • Optional place_id?: string

      The place_id that you want to geocode. You can retrieve this information from Places API for example.

    • Optional region?: string

      The region code, specified as a ccTLD ("top-level domain") two-character value. This parameter will only influence, not fully restrict, results from the geocoder.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/GeocodeResponse.html b/interfaces/GeocodeResponse.html index ddd072dc43..37256e5cd7 100644 --- a/interfaces/GeocodeResponse.html +++ b/interfaces/GeocodeResponse.html @@ -1,2 +1,2 @@ -GeocodeResponse | Google Maps Services Node Client
    interface GeocodeResponse {
        data: GeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeocodeResponse

    Properties

    Properties

    \ No newline at end of file +GeocodeResponse | Google Maps Services Node Client
    interface GeocodeResponse {
        data: GeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeocodeResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/GeocodeResponseData.html b/interfaces/GeocodeResponseData.html index 6849801204..cd5729b280 100644 --- a/interfaces/GeocodeResponseData.html +++ b/interfaces/GeocodeResponseData.html @@ -1,17 +1,17 @@ -GeocodeResponseData | Google Maps Services Node Client
    interface GeocodeResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +GeocodeResponseData | Google Maps Services Node Client
    interface GeocodeResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    +
    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    Generally, only one entry in the "results" array is returned for address lookups,though the geocoder may return several results when address queries are ambiguous.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/GeocodeResult.html b/interfaces/GeocodeResult.html index f8a10a0ea6..b179541aa6 100644 --- a/interfaces/GeocodeResult.html +++ b/interfaces/GeocodeResult.html @@ -1,4 +1,4 @@ -GeocodeResult | Google Maps Services Node Client
    interface GeocodeResult {
        address_components: AddressComponent[];
        formatted_address: string;
        geometry: AddressGeometry;
        partial_match: boolean;
        place_id: string;
        plus_code: PlusCode;
        postcode_localities: string[];
        types: AddressType[];
    }

    Properties

    address_components +GeocodeResult | Google Maps Services Node Client
    interface GeocodeResult {
        address_components: AddressComponent[];
        formatted_address: string;
        geometry: AddressGeometry;
        partial_match: boolean;
        place_id: string;
        plus_code: PlusCode;
        postcode_localities: string[];
        types: AddressType[];
    }

    Properties

    address_components formatted_address geometry partial_match @@ -18,7 +18,7 @@ over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response. -
    formatted_address: string

    is a string containing the human-readable address of this location.

    +
    formatted_address: string

    is a string containing the human-readable address of this location.

    Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.

    The formatted address is logically composed of one or more address components. @@ -26,8 +26,8 @@ "8th Avenue" (the route), "New York" (the city) and "NY" (the US state).

    Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field.

    -
    geometry: AddressGeometry

    address geometry.

    -
    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, +

    geometry: AddressGeometry

    address geometry.

    +
    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

    Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. @@ -35,8 +35,8 @@ For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

    -
    place_id: string

    is a unique identifier that can be used with other Google APIs.

    -
    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, +

    place_id: string

    is a unique identifier that can be used with other Google APIs.

    +
    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named).

    @@ -51,10 +51,10 @@
  • Open Location Code
  • plus codes
  • -
    postcode_localities: string[]

    is an array denoting all the localities contained in a postal code. +

    postcode_localities: string[]

    is an array denoting all the localities contained in a postal code. This is only present when the result is a postal code that contains multiple localities.

    -
    types: AddressType[]

    array indicates the type of the returned result. +

    types: AddressType[]

    array indicates the type of the returned result. This array contains a set of zero or more tags identifying the type of feature returned in the result. For example, a geocode of "Chicago" returns "locality" which indicates that "Chicago" is a city, and also returns "political" which indicates it is a political entity.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/GeocodedWaypoint.html b/interfaces/GeocodedWaypoint.html index 7d48723896..cb5f6ce276 100644 --- a/interfaces/GeocodedWaypoint.html +++ b/interfaces/GeocodedWaypoint.html @@ -1,18 +1,18 @@ GeocodedWaypoint | Google Maps Services Node Client

    Elements in the geocoded_waypoints array correspond, by their zero-based position, to the origin, the waypoints in the order they are specified, and the destination.

    -
    interface GeocodedWaypoint {
        geocoder_status: GeocodedWaypointStatus;
        partial_match: boolean;
        place_id: string;
        types: AddressType[];
    }

    Properties

    interface GeocodedWaypoint {
        geocoder_status: GeocodedWaypointStatus;
        partial_match: boolean;
        place_id: string;
        types: AddressType[];
    }

    Properties

    geocoder_status: GeocodedWaypointStatus

    indicates the status code resulting from the geocoding operation.

    -
    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the +

    partial_match: boolean

    indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

    Partial matches most often occur for street addresses that do not exist within the locality you pass in the request. Partial matches may also be returned when a request matches two or more locations in the same locality. For example, "21 Henr St, Bristol, UK" will return a partial match for both Henry Street and Henrietta Street. Note that if a request includes a misspelled address component, the geocoding service may suggest an alternative address. Suggestions triggered in this way will also be marked as a partial match.

    -
    place_id: string

    unique identifier that can be used with other Google APIs.

    -
    types: AddressType[]

    indicates the address type of the geocoding result used for calculating directions.

    +
    place_id: string

    unique identifier that can be used with other Google APIs.

    +
    types: AddressType[]

    indicates the address type of the geocoding result used for calculating directions.

    An empty list of types indicates there are no known types for the particular address component, for example, Lieu-dit in France.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/GeolocateRequest.html b/interfaces/GeolocateRequest.html index 69cbfbb8c3..88d4bd5cce 100644 --- a/interfaces/GeolocateRequest.html +++ b/interfaces/GeolocateRequest.html @@ -1,4 +1,4 @@ -GeolocateRequest | Google Maps Services Node Client
    interface GeolocateRequest {
        data: {
            carrier?: string;
            cellTowers?: CellTower[];
            considerIp?: boolean;
            homeMobileCountryCode?: number;
            homeMobileNetworkCode?: number;
            radioType?: RadioType;
            wifiAccessPoints?: WifiAccessPoint[];
        };
        params: RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeolocateRequest

    Properties

    data +GeolocateRequest | Google Maps Services Node Client
    interface GeolocateRequest {
        data: {
            carrier?: string;
            cellTowers?: CellTower[];
            considerIp?: boolean;
            homeMobileCountryCode?: number;
            homeMobileNetworkCode?: number;
            radioType?: RadioType;
            wifiAccessPoints?: WifiAccessPoint[];
        };
        params: RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • GeolocateRequest

    Properties

    Properties

    data: {
        carrier?: string;
        cellTowers?: CellTower[];
        considerIp?: boolean;
        homeMobileCountryCode?: number;
        homeMobileNetworkCode?: number;
        radioType?: RadioType;
        wifiAccessPoints?: WifiAccessPoint[];
    }

    Type declaration

    • Optional carrier?: string

      The carrier name.

    • Optional cellTowers?: CellTower[]

      An array of cell tower objects.

      @@ -8,4 +8,4 @@
    • Optional homeMobileNetworkCode?: number

      The mobile network code (MNC) for the device's home network.

    • Optional radioType?: RadioType

      The mobile radio type. While this field is optional, it should be included if a value is available, for more accurate results.

    • Optional wifiAccessPoints?: WifiAccessPoint[]

      An array of WiFi access point objects.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/GeolocateResponseData.html b/interfaces/GeolocateResponseData.html index cf19985011..3a88f36a4a 100644 --- a/interfaces/GeolocateResponseData.html +++ b/interfaces/GeolocateResponseData.html @@ -1,17 +1,17 @@ -GeolocateResponseData | Google Maps Services Node Client
    interface GeolocateResponseData {
        accuracy: number;
        error_message: string;
        html_attributions?: string[];
        location: LatLngLiteral;
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    accuracy +GeolocateResponseData | Google Maps Services Node Client
    interface GeolocateResponseData {
        accuracy: number;
        error_message: string;
        html_attributions?: string[];
        location: LatLngLiteral;
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    accuracy: number

    The accuracy of the estimated location, in meters. This represents the radius of a circle around the given location.

    -
    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    location: LatLngLiteral

    The user's estimated latitude and longitude, in degrees. Contains one lat and one lng subfield.

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    location: LatLngLiteral

    The user's estimated latitude and longitude, in degrees. Contains one lat and one lng subfield.

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/GeolocateResponseError.html b/interfaces/GeolocateResponseError.html index 2e1d1c5e9b..53b463c896 100644 --- a/interfaces/GeolocateResponseError.html +++ b/interfaces/GeolocateResponseError.html @@ -1,8 +1,8 @@ GeolocateResponseError | Google Maps Services Node Client

    In the case of an error, a standard format error response body will be returned and the HTTP status code will be set to an error status.

    -
    interface GeolocateResponseError {
        data: {
            error: {
                code: number;
                errors: {
                    domain: string;
                    message: string;
                    reason: GeolocateErrorReason;
                }[];
                message: string;
            };
        };
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseError

    Properties

    interface GeolocateResponseError {
        data: {
            error: {
                code: number;
                errors: {
                    domain: string;
                    message: string;
                    reason: GeolocateErrorReason;
                }[];
                message: string;
            };
        };
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseError

    Properties

    Properties

    data: {
        error: {
            code: number;
            errors: {
                domain: string;
                message: string;
                reason: GeolocateErrorReason;
            }[];
            message: string;
        };
    }

    Type declaration

    • error: {
          code: number;
          errors: {
              domain: string;
              message: string;
              reason: GeolocateErrorReason;
          }[];
          message: string;
      }
      • code: number

        This is the same as the HTTP status of the response.

      • errors: {
            domain: string;
            message: string;
            reason: GeolocateErrorReason;
        }[]

        A list of errors which occurred. Each error contains an identifier for the type of error (the reason) and a short description (the message).

      • message: string

        A short description of the error.

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/GeolocateResponseSuccess.html b/interfaces/GeolocateResponseSuccess.html index 18046e6605..3f9fc67c3e 100644 --- a/interfaces/GeolocateResponseSuccess.html +++ b/interfaces/GeolocateResponseSuccess.html @@ -1,2 +1,2 @@ -GeolocateResponseSuccess | Google Maps Services Node Client
    interface GeolocateResponseSuccess {
        data: GeolocateResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseSuccess

    Properties

    Properties

    \ No newline at end of file +GeolocateResponseSuccess | Google Maps Services Node Client
    interface GeolocateResponseSuccess {
        data: GeolocateResponseData;
    }

    Hierarchy

    • AxiosResponse
      • GeolocateResponseSuccess

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/LatLngBounds.html b/interfaces/LatLngBounds.html index 1ea7e749f0..3936b0e83a 100644 --- a/interfaces/LatLngBounds.html +++ b/interfaces/LatLngBounds.html @@ -1,4 +1,4 @@ LatLngBounds | Google Maps Services Node Client

    The bounds parameter defines the latitude/longitude coordinates of the southwest and northeast corners of this bounding box.

    -
    interface LatLngBounds {
        northeast: LatLngLiteral;
        southwest: LatLngLiteral;
    }

    Properties

    interface LatLngBounds {
        northeast: LatLngLiteral;
        southwest: LatLngLiteral;
    }

    Properties

    Properties

    northeast: LatLngLiteral
    southwest: LatLngLiteral
    \ No newline at end of file +

    Properties

    northeast: LatLngLiteral
    southwest: LatLngLiteral
    \ No newline at end of file diff --git a/interfaces/LatLngLiteral.html b/interfaces/LatLngLiteral.html index d6e60d4163..4be73c1a19 100644 --- a/interfaces/LatLngLiteral.html +++ b/interfaces/LatLngLiteral.html @@ -1,3 +1,3 @@ -LatLngLiteral | Google Maps Services Node Client
    interface LatLngLiteral {
        lat: number;
        lng: number;
    }

    Properties

    lat +LatLngLiteral | Google Maps Services Node Client
    interface LatLngLiteral {
        lat: number;
        lng: number;
    }

    Properties

    Properties

    lat: number
    lng: number
    \ No newline at end of file +

    Properties

    lat: number
    lng: number
    \ No newline at end of file diff --git a/interfaces/LatLngLiteralVerbose.html b/interfaces/LatLngLiteralVerbose.html index 1931a69815..a63231650d 100644 --- a/interfaces/LatLngLiteralVerbose.html +++ b/interfaces/LatLngLiteralVerbose.html @@ -1,3 +1,3 @@ -LatLngLiteralVerbose | Google Maps Services Node Client
    interface LatLngLiteralVerbose {
        latitude: number;
        longitude: number;
    }

    Properties

    latitude +LatLngLiteralVerbose | Google Maps Services Node Client
    interface LatLngLiteralVerbose {
        latitude: number;
        longitude: number;
    }

    Properties

    Properties

    latitude: number
    longitude: number
    \ No newline at end of file +

    Properties

    latitude: number
    longitude: number
    \ No newline at end of file diff --git a/interfaces/NearestRoadsRequest.html b/interfaces/NearestRoadsRequest.html index 489b3a0fb0..8a7730c8ad 100644 --- a/interfaces/NearestRoadsRequest.html +++ b/interfaces/NearestRoadsRequest.html @@ -1,5 +1,5 @@ -NearestRoadsRequest | Google Maps Services Node Client
    interface NearestRoadsRequest {
        params: {
            points: LatLng[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • NearestRoadsRequest

    Properties

    params +NearestRoadsRequest | Google Maps Services Node Client
    interface NearestRoadsRequest {
        params: {
            points: LatLng[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • NearestRoadsRequest

    Properties

    Properties

    params: {
        points: LatLng[];
    } & RequestParams

    Type declaration

    • points: LatLng[]

      A list of latitude/longitude pairs. Latitude and longitude values should be separated by commas. Coordinates should be separated by the pipe character: "|". For example: points=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/NearestRoadsResponse.html b/interfaces/NearestRoadsResponse.html index 0623962237..9a55f063e5 100644 --- a/interfaces/NearestRoadsResponse.html +++ b/interfaces/NearestRoadsResponse.html @@ -1,3 +1,3 @@ -NearestRoadsResponse | Google Maps Services Node Client
    interface NearestRoadsResponse {
        data: {
            snappedPoints: SnappedPoint[];
        };
    }

    Hierarchy

    • AxiosResponse
      • NearestRoadsResponse

    Properties

    data +NearestRoadsResponse | Google Maps Services Node Client
    interface NearestRoadsResponse {
        data: {
            snappedPoints: SnappedPoint[];
        };
    }

    Hierarchy

    • AxiosResponse
      • NearestRoadsResponse

    Properties

    Properties

    data: {
        snappedPoints: SnappedPoint[];
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/OpeningHours.html b/interfaces/OpeningHours.html index 23f88f1bea..7900601a52 100644 --- a/interfaces/OpeningHours.html +++ b/interfaces/OpeningHours.html @@ -1,10 +1,10 @@ -OpeningHours | Google Maps Services Node Client
    interface OpeningHours {
        open_now: boolean;
        periods: OpeningPeriod[];
        weekday_text: string[];
    }

    Properties

    open_now +OpeningHours | Google Maps Services Node Client
    interface OpeningHours {
        open_now: boolean;
        periods: OpeningPeriod[];
        weekday_text: string[];
    }

    Properties

    open_now: boolean

    is a boolean value indicating if the place is open at the current time.

    -
    periods: OpeningPeriod[]

    is an array of opening periods covering seven days, starting from Sunday, in chronological order.

    -
    weekday_text: string[]

    is an array of seven strings representing the formatted opening hours for each day of the week. +

    periods: OpeningPeriod[]

    is an array of opening periods covering seven days, starting from Sunday, in chronological order.

    +
    weekday_text: string[]

    is an array of seven strings representing the formatted opening hours for each day of the week. If a language parameter was specified in the Place Details request, the Places Service will format and localize the opening hours appropriately for that language. The ordering of the elements in this array depends on the language parameter. Some languages start the week on Monday while others start on Sunday.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/OpeningHoursTime.html b/interfaces/OpeningHoursTime.html index de7f0384bb..fb314340ce 100644 --- a/interfaces/OpeningHoursTime.html +++ b/interfaces/OpeningHoursTime.html @@ -1,6 +1,6 @@ -OpeningHoursTime | Google Maps Services Node Client
    interface OpeningHoursTime {
        day: number;
        time?: string;
    }

    Properties

    day +OpeningHoursTime | Google Maps Services Node Client
    interface OpeningHoursTime {
        day: number;
        time?: string;
    }

    Properties

    Properties

    day: number

    a number from 0–6, corresponding to the days of the week, starting on Sunday. For example, 2 means Tuesday.

    -
    time?: string

    may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time +

    time?: string

    may contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time will be reported in the place's time zone.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/OpeningPeriod.html b/interfaces/OpeningPeriod.html index f59d0758c0..9f03867353 100644 --- a/interfaces/OpeningPeriod.html +++ b/interfaces/OpeningPeriod.html @@ -1,8 +1,8 @@ -OpeningPeriod | Google Maps Services Node Client
    interface OpeningPeriod {
        close?: OpeningHoursTime;
        open: OpeningHoursTime;
    }

    Properties

    close? +OpeningPeriod | Google Maps Services Node Client
    interface OpeningPeriod {
        close?: OpeningHoursTime;
        open: OpeningHoursTime;
    }

    Properties

    Properties

    may contain a pair of day and time objects describing when the place closes. Note: If a place is always open, the close section will be missing from the response. Clients can rely on always-open being represented as an open period containing day with value 0 and time with value 0000, and no close.

    -

    contains a pair of day and time objects describing when the place opens.

    -
    \ No newline at end of file +

    contains a pair of day and time objects describing when the place opens.

    +
    \ No newline at end of file diff --git a/interfaces/PlaceAutocompleteRequest.html b/interfaces/PlaceAutocompleteRequest.html index fd237fc5e5..38d456438d 100644 --- a/interfaces/PlaceAutocompleteRequest.html +++ b/interfaces/PlaceAutocompleteRequest.html @@ -1,4 +1,4 @@ -PlaceAutocompleteRequest | Google Maps Services Node Client
    interface PlaceAutocompleteRequest {
        params: {
            components?: string[];
            input: string;
            language?: string;
            location?: LatLng;
            offset?: number;
            origin?: LatLng;
            radius?: number;
            sessiontoken?: string;
            strictbounds?: boolean;
            types?: PlaceAutocompleteType;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceAutocompleteRequest

    Properties

    params +PlaceAutocompleteRequest | Google Maps Services Node Client
    interface PlaceAutocompleteRequest {
        params: {
            components?: string[];
            input: string;
            language?: string;
            location?: LatLng;
            offset?: number;
            origin?: LatLng;
            radius?: number;
            sessiontoken?: string;
            strictbounds?: boolean;
            types?: PlaceAutocompleteType;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceAutocompleteRequest

    Properties

    Properties

    params: {
        components?: string[];
        input: string;
        language?: string;
        location?: LatLng;
        offset?: number;
        origin?: LatLng;
        radius?: number;
        sessiontoken?: string;
        strictbounds?: boolean;
        types?: PlaceAutocompleteType;
    } & RequestParams

    Type declaration

    • Optional components?: string[]

      A grouping of places to which you would like to restrict your results. Currently, you can use components to filter by up to 5 countries. Countries must be passed as a two character, ISO 3166-1 Alpha-2 compatible country code. @@ -32,4 +32,4 @@ This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.

    • Optional types?: PlaceAutocompleteType

      The types of place results to return.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PlaceAutocompleteResponse.html b/interfaces/PlaceAutocompleteResponse.html index 74438a4e63..57403827e5 100644 --- a/interfaces/PlaceAutocompleteResponse.html +++ b/interfaces/PlaceAutocompleteResponse.html @@ -1,2 +1,2 @@ -PlaceAutocompleteResponse | Google Maps Services Node Client
    interface PlaceAutocompleteResponse {
        data: PlaceAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceAutocompleteResponse

    Properties

    Properties

    \ No newline at end of file +PlaceAutocompleteResponse | Google Maps Services Node Client
    interface PlaceAutocompleteResponse {
        data: PlaceAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceAutocompleteResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/PlaceAutocompleteResponseData.html b/interfaces/PlaceAutocompleteResponseData.html index 5288ef4160..b52ab9c2a9 100644 --- a/interfaces/PlaceAutocompleteResponseData.html +++ b/interfaces/PlaceAutocompleteResponseData.html @@ -1,17 +1,17 @@ -PlaceAutocompleteResponseData | Google Maps Services Node Client
    interface PlaceAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceAutocompleteResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +PlaceAutocompleteResponseData | Google Maps Services Node Client
    interface PlaceAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceAutocompleteResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    contains an array of places, with information about the place. +

    contains an array of places, with information about the place. See Place Autocomplete Results for information about these results. The Places API returns up to 5 results.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/PlaceAutocompleteResult.html b/interfaces/PlaceAutocompleteResult.html index c6d2d22d50..97e3fea5c3 100644 --- a/interfaces/PlaceAutocompleteResult.html +++ b/interfaces/PlaceAutocompleteResult.html @@ -1,4 +1,4 @@ -PlaceAutocompleteResult | Google Maps Services Node Client
    interface PlaceAutocompleteResult {
        description: string;
        distance_meters?: number;
        matched_substrings: PredictionSubstring[];
        place_id: string;
        structured_formatting: StructuredFormatting;
        terms: PredictionTerm[];
        types: AddressType[];
    }

    Properties

    description +PlaceAutocompleteResult | Google Maps Services Node Client
    interface PlaceAutocompleteResult {
        description: string;
        distance_meters?: number;
        matched_substrings: PredictionSubstring[];
        place_id: string;
        structured_formatting: StructuredFormatting;
        terms: PredictionTerm[];
        types: AddressType[];
    }

    Properties

    description: string

    contains the human-readable name for the returned result. For establishment results, this is usually the business name.

    -
    distance_meters?: number

    contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. +

    distance_meters?: number

    contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. This field is only returned when the origin point is specified in the request. This field is not returned in predictions of type route.

    -
    matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -
    place_id: string

    is a textual identifier that uniquely identifies a place. +

    place_id: string

    is a textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request.

    -
    structured_formatting: StructuredFormatting

    contains details on the prediction.

    -

    contains an array of terms identifying each section of the returned description +

    structured_formatting: StructuredFormatting

    contains details on the prediction.

    +

    contains an array of terms identifying each section of the returned description (a section of the description is generally terminated with a comma).

    -
    types: AddressType[]

    contains an array of types that apply to this place. +

    types: AddressType[]

    contains an array of types that apply to this place. For example: [ "political", "locality" ] or [ "establishment", "geocode" ].

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PlaceData.html b/interfaces/PlaceData.html index 1f4fd4c31b..3433301dc2 100644 --- a/interfaces/PlaceData.html +++ b/interfaces/PlaceData.html @@ -1,4 +1,4 @@ -PlaceData | Google Maps Services Node Client
    interface PlaceData {
        address_components: AddressComponent[];
        adr_address: string;
        business_status: string;
        editorial_summary: PlaceEditorialSummary;
        formatted_address: string;
        formatted_phone_number: string;
        geometry: AddressGeometry;
        icon: string;
        icon_background_color: string;
        icon_mask_base_uri: string;
        international_phone_number: string;
        name: string;
        opening_hours: OpeningHours;
        permanently_closed: boolean;
        photos: PlacePhoto[];
        place_id: string;
        plus_code: PlusCode;
        price_level: number;
        rating: number;
        reviews: PlaceReview[];
        types: AddressType[];
        url: string;
        user_ratings_total: number;
        utc_offset: number;
        vicinity: string;
        website: string;
    }

    Properties

    address_components +PlaceData | Google Maps Services Node Client
    interface PlaceData {
        address_components: AddressComponent[];
        adr_address: string;
        business_status: string;
        editorial_summary: PlaceEditorialSummary;
        formatted_address: string;
        formatted_phone_number: string;
        geometry: AddressGeometry;
        icon: string;
        icon_background_color: string;
        icon_mask_base_uri: string;
        international_phone_number: string;
        name: string;
        opening_hours: OpeningHours;
        permanently_closed: boolean;
        photos: PlacePhoto[];
        place_id: string;
        plus_code: PlusCode;
        price_level: number;
        rating: number;
        reviews: PlaceReview[];
        types: AddressType[];
        url: string;
        user_ratings_total: number;
        utc_offset: number;
        vicinity: string;
        website: string;
    }

    Properties

    address_components adr_address business_status editorial_summary @@ -37,11 +37,11 @@ and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response. -
    adr_address: string

    is a representation of the place's address in the adr microformat.

    -
    business_status: string

    is a string indicating the operational status of the place, if it is a business.

    -
    editorial_summary: PlaceEditorialSummary

    Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code +

    adr_address: string

    is a representation of the place's address in the adr microformat.

    +
    business_status: string

    is a string indicating the operational status of the place, if it is a business.

    +
    editorial_summary: PlaceEditorialSummary

    Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.

    -
    formatted_address: string

    is a string containing the human-readable address of this place.

    +
    formatted_address: string

    is a string containing the human-readable address of this place.

    Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.

    The formatted address is logically composed of one or more address components. @@ -49,32 +49,32 @@ (the street number), "8th Avenue" (the route), "New York" (the city) and "NY" (the US state).

    Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field.

    -
    formatted_phone_number: string

    contains the place's phone number in its local format. +

    formatted_phone_number: string

    contains the place's phone number in its local format. For example, the formatted_phone_number for Google's Sydney, Australia office is (02) 9374 4000.

    -
    geometry: AddressGeometry

    contains the following information:

    +
    geometry: AddressGeometry

    contains the following information:

    • location: contains the geocoded latitude,longitude value for this place.
    • viewport: contains the preferred viewport when displaying this place on a map as a LatLngBounds if it is known.
    -
    icon: string

    contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map.

    -
    icon_background_color: string

    The default HEX color code for the place's category.

    +
    icon: string

    contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map.

    +
    icon_background_color: string

    The default HEX color code for the place's category.

    icon_mask_base_uri: string

    The base URL for a non-colored icon, minus the file type extension (append .svg or .png).

    +
    icon_mask_base_uri: string

    The base URL for a non-colored icon, minus the file type extension (append .svg or .png).

    international_phone_number: string

    contains the place's phone number in international format. +

    international_phone_number: string

    contains the place's phone number in international format. International format includes the country code, and is prefixed with the plus (+) sign. For example, the international_phone_number for Google's Sydney, Australia office is +61 2 9374 4000.

    -
    name: string

    contains the human-readable name for the returned result. +

    name: string

    contains the human-readable name for the returned result. For establishment results, this is usually the canonicalized business name.

    -
    opening_hours: OpeningHours

    place opening hours.

    -
    permanently_closed: boolean

    is a boolean flag indicating whether the place has permanently shut down (value true). +

    opening_hours: OpeningHours

    place opening hours.

    +
    permanently_closed: boolean

    is a boolean flag indicating whether the place has permanently shut down (value true). If the place is not permanently closed, the flag is absent from the response. This field is deprecated in favor of business_status.

    -
    photos: PlacePhoto[]

    an array of photo objects, each containing a reference to an image. +

    photos: PlacePhoto[]

    an array of photo objects, each containing a reference to an image. A Place Details request may return up to ten photos. More information about place photos and how you can use the images in your application can be found in the Place Photos documentation.

    -
    place_id: string

    A textual identifier that uniquely identifies a place. +

    place_id: string

    A textual identifier that uniquely identifies a place. To retrieve information about the place, pass this identifier in the placeId field of a Places API request.

    -
    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: +

    plus_code: PlusCode

    is an encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named).

    @@ -89,7 +89,7 @@
  • Open Location Code
  • plus codes
  • -
    price_level: number

    The price level of the place, on a scale of 0 to 4. +

    price_level: number

    The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific value will vary from region to region.

    Price levels are interpreted as follows:

      @@ -99,20 +99,20 @@
    • 3: Expensive
    • 4: Very Expensive
    -
    rating: number

    contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews.

    -
    reviews: PlaceReview[]

    a JSON array of up to five reviews. If a language parameter was specified in the Place Details request, +

    rating: number

    contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews.

    +
    reviews: PlaceReview[]

    a JSON array of up to five reviews. If a language parameter was specified in the Place Details request, the Places Service will bias the results to prefer reviews written in that language.

    -
    types: AddressType[]

    contains an array of feature types describing the given result. +

    types: AddressType[]

    contains an array of feature types describing the given result. XML responses include multiple <type> elements if more than one type is assigned to the result.

    -
    url: string

    contains the URL of the official Google page for this place. +

    url: string

    contains the URL of the official Google page for this place. This will be the Google-owned page that contains the best available information about the place. Applications must link to or embed this page on any screen that shows detailed results about the place to the user.

    -
    user_ratings_total: number

    The total number of ratings from users

    -
    utc_offset: number

    contains the number of minutes this place’s current timezone is offset from UTC. +

    user_ratings_total: number

    The total number of ratings from users

    +
    utc_offset: number

    contains the number of minutes this place’s current timezone is offset from UTC. For example, for places in Sydney, Australia during daylight saving time this would be 660 (+11 hours from UTC), and for places in California outside of daylight saving time this would be -480 (-8 hours from UTC).

    -
    vicinity: string

    lists a simplified address for the place, including the street name, street number, and locality, +

    vicinity: string

    lists a simplified address for the place, including the street name, street number, and locality, but not the province/state, postal code, or country. For example, Google's Sydney, Australia office has a vicinity value of 48 Pirrama Road, Pyrmont.

    -
    website: string

    lists the authoritative website for this place, such as a business' homepage.

    -
    \ No newline at end of file +
    website: string

    lists the authoritative website for this place, such as a business' homepage.

    +
    \ No newline at end of file diff --git a/interfaces/PlaceDetailsRequest.html b/interfaces/PlaceDetailsRequest.html index 185c61c834..de7a6dc017 100644 --- a/interfaces/PlaceDetailsRequest.html +++ b/interfaces/PlaceDetailsRequest.html @@ -1,4 +1,4 @@ -PlaceDetailsRequest | Google Maps Services Node Client
    interface PlaceDetailsRequest {
        params: {
            fields?: string[];
            language?: Language;
            place_id: string;
            region?: string;
            sessiontoken?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceDetailsRequest

    Properties

    params +PlaceDetailsRequest | Google Maps Services Node Client
    interface PlaceDetailsRequest {
        params: {
            fields?: string[];
            language?: Language;
            place_id: string;
            region?: string;
            sessiontoken?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceDetailsRequest

    Properties

    Properties

    params: {
        fields?: string[];
        language?: Language;
        place_id: string;
        region?: string;
        sessiontoken?: string;
    } & RequestParams

    Type declaration

    • Optional fields?: string[]

      One or more fields, specifying the types of place data to return, separated by a comma.

      **Warning: If you do not specify at least one field with a request, or if you omit the fields parameter from a request, ALL possible fields will be returned, and you will be billed accordingly. @@ -15,4 +15,4 @@ for results in the specified region.

    • Optional sessiontoken?: string

      A random string which identifies an autocomplete session for billing purposes. Use this for Place Details requests that are called following an autocomplete request in the same user session

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PlaceDetailsResponse.html b/interfaces/PlaceDetailsResponse.html index d68facb6ae..47c5761879 100644 --- a/interfaces/PlaceDetailsResponse.html +++ b/interfaces/PlaceDetailsResponse.html @@ -1,2 +1,2 @@ -PlaceDetailsResponse | Google Maps Services Node Client
    interface PlaceDetailsResponse {
        data: PlaceDetailsResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceDetailsResponse

    Properties

    Properties

    \ No newline at end of file +PlaceDetailsResponse | Google Maps Services Node Client
    interface PlaceDetailsResponse {
        data: PlaceDetailsResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceDetailsResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/PlaceDetailsResponseData.html b/interfaces/PlaceDetailsResponseData.html index d71a34ed9a..3fc2b9cc85 100644 --- a/interfaces/PlaceDetailsResponseData.html +++ b/interfaces/PlaceDetailsResponseData.html @@ -1,14 +1,14 @@ -PlaceDetailsResponseData | Google Maps Services Node Client
    interface PlaceDetailsResponseData {
        error_message: string;
        html_attributions: string[];
        next_page_token?: string;
        result: Partial<PlaceData>;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +PlaceDetailsResponseData | Google Maps Services Node Client
    interface PlaceDetailsResponseData {
        error_message: string;
        html_attributions: string[];
        next_page_token?: string;
        result: Partial<PlaceData>;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions: string[]

    contains a set of attributions about this listing which must be displayed to the user.

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions: string[]

    contains a set of attributions about this listing which must be displayed to the user.

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    result: Partial<PlaceData>
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    result: Partial<PlaceData>
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/PlaceEditorialSummary.html b/interfaces/PlaceEditorialSummary.html index 3b85dab7c1..f2953c8c81 100644 --- a/interfaces/PlaceEditorialSummary.html +++ b/interfaces/PlaceEditorialSummary.html @@ -1,5 +1,5 @@ -PlaceEditorialSummary | Google Maps Services Node Client
    interface PlaceEditorialSummary {
        language?: string;
        overview?: string;
    }

    Properties

    language? +PlaceEditorialSummary | Google Maps Services Node Client
    interface PlaceEditorialSummary {
        language?: string;
        overview?: string;
    }

    Properties

    Properties

    language?: string

    The language of the previous fields. May not always be present.

    -
    overview?: string

    A medium-length textual summary of the place.

    -
    \ No newline at end of file +
    overview?: string

    A medium-length textual summary of the place.

    +
    \ No newline at end of file diff --git a/interfaces/PlacePhoto.html b/interfaces/PlacePhoto.html index aaa887b6c7..0bb2477e12 100644 --- a/interfaces/PlacePhoto.html +++ b/interfaces/PlacePhoto.html @@ -1,9 +1,9 @@ -PlacePhoto | Google Maps Services Node Client
    interface PlacePhoto {
        height: number;
        html_attributions: string[];
        photo_reference: string;
        width: number;
    }

    Properties

    height +PlacePhoto | Google Maps Services Node Client
    interface PlacePhoto {
        height: number;
        html_attributions: string[];
        photo_reference: string;
        width: number;
    }

    Properties

    height: number

    the maximum height of the image.

    -
    html_attributions: string[]

    contains any required attributions. This field will always be present, but may be empty.

    -
    photo_reference: string

    a string used to identify the photo when you perform a Photo request.

    -
    width: number

    the maximum width of the image.

    -
    \ No newline at end of file +
    html_attributions: string[]

    contains any required attributions. This field will always be present, but may be empty.

    +
    photo_reference: string

    a string used to identify the photo when you perform a Photo request.

    +
    width: number

    the maximum width of the image.

    +
    \ No newline at end of file diff --git a/interfaces/PlacePhotoRequest.html b/interfaces/PlacePhotoRequest.html index 2ed8b54195..4e8719f003 100644 --- a/interfaces/PlacePhotoRequest.html +++ b/interfaces/PlacePhotoRequest.html @@ -1,4 +1,4 @@ -PlacePhotoRequest | Google Maps Services Node Client
    interface PlacePhotoRequest {
        params: {
            maxheight?: number;
            maxwidth?: number;
            photoreference: string;
        } & RequestParams;
        responseType: "stream" | "arraybuffer" | "blob";
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacePhotoRequest

    Properties

    params +PlacePhotoRequest | Google Maps Services Node Client
    interface PlacePhotoRequest {
        params: {
            maxheight?: number;
            maxwidth?: number;
            photoreference: string;
        } & RequestParams;
        responseType: "stream" | "arraybuffer" | "blob";
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacePhotoRequest

    Properties

    Properties

    params: {
        maxheight?: number;
        maxwidth?: number;
        photoreference: string;
    } & RequestParams

    Type declaration

    • Optional maxheight?: number

      Specifies the maximum desired height or width, in pixels, of the image returned by the Place Photos service. If the image is smaller than the values specified, the original image will be returned. @@ -10,4 +10,4 @@ restricted to its original aspect ratio. Both the maxheight and maxwidth properties accept an integer between 1 and 1600.

    • photoreference: string

      string identifier that uniquely identifies a photo. Photo references are returned from either a Place Search or Place Details request.

      -
    responseType: "stream" | "arraybuffer" | "blob"
    \ No newline at end of file +
    responseType: "stream" | "arraybuffer" | "blob"
    \ No newline at end of file diff --git a/interfaces/PlacePhotoResponse.html b/interfaces/PlacePhotoResponse.html index 09244afcc8..9d4a8696d3 100644 --- a/interfaces/PlacePhotoResponse.html +++ b/interfaces/PlacePhotoResponse.html @@ -7,4 +7,4 @@
  • The submitted photo reference was incorrectly specified.
  • Your request did not include either a maxwidth or maxheight parameter.
  • -
    interface PlacePhotoResponse {}

    Hierarchy

    \ No newline at end of file +
    interface PlacePhotoResponse {}

    Hierarchy

    \ No newline at end of file diff --git a/interfaces/PlaceQueryAutocompletePrediction.html b/interfaces/PlaceQueryAutocompletePrediction.html index 9b2fc7710a..80f85c2361 100644 --- a/interfaces/PlaceQueryAutocompletePrediction.html +++ b/interfaces/PlaceQueryAutocompletePrediction.html @@ -1,12 +1,12 @@ -PlaceQueryAutocompletePrediction | Google Maps Services Node Client
    interface PlaceQueryAutocompletePrediction {
        description: string;
        matched_substrings: PredictionSubstring[];
        place_id?: string;
        structured_formatting?: StructuredFormatting[];
        terms: PredictionTerm[];
        types?: string[];
    }

    Properties

    description +PlaceQueryAutocompletePrediction | Google Maps Services Node Client
    interface PlaceQueryAutocompletePrediction {
        description: string;
        matched_substrings: PredictionSubstring[];
        place_id?: string;
        structured_formatting?: StructuredFormatting[];
        terms: PredictionTerm[];
        types?: string[];
    }

    Properties

    description: string

    contains the human-readable name for the returned result. For establishment results, this is usually the business name.

    -
    matched_substrings: PredictionSubstring[]

    contains an offset value and a length. +

    matched_substrings: PredictionSubstring[]

    contains an offset value and a length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -
    place_id?: string
    structured_formatting?: StructuredFormatting[]

    contains an array of terms identifying each section of the returned description +

    place_id?: string
    structured_formatting?: StructuredFormatting[]

    contains an array of terms identifying each section of the returned description (a section of the description is generally terminated with a comma).

    -
    types?: string[]
    \ No newline at end of file +
    types?: string[]
    \ No newline at end of file diff --git a/interfaces/PlaceQueryAutocompleteRequest.html b/interfaces/PlaceQueryAutocompleteRequest.html index bbe56db105..f6192c4da1 100644 --- a/interfaces/PlaceQueryAutocompleteRequest.html +++ b/interfaces/PlaceQueryAutocompleteRequest.html @@ -1,4 +1,4 @@ -PlaceQueryAutocompleteRequest | Google Maps Services Node Client
    interface PlaceQueryAutocompleteRequest {
        params: {
            input: string;
            language?: Language;
            location?: LatLng;
            offset?: number;
            radius?: number;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceQueryAutocompleteRequest

    Properties

    params +PlaceQueryAutocompleteRequest | Google Maps Services Node Client
    interface PlaceQueryAutocompleteRequest {
        params: {
            input: string;
            language?: Language;
            location?: LatLng;
            offset?: number;
            radius?: number;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlaceQueryAutocompleteRequest

    Properties

    Properties

    params: {
        input: string;
        language?: Language;
        location?: LatLng;
        offset?: number;
        radius?: number;
    } & RequestParams

    Type declaration

    • input: string

      The text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.

    • Optional language?: Language

      The language code, indicating in which language the results should be returned, if possible. @@ -11,4 +11,4 @@ If no offset is supplied, the service will use the entire term.

    • Optional radius?: number

      The distance (in meters) within which to return place results. Note that setting a radius biases results to the indicated area, but may not fully restrict results to the specified area.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PlaceQueryAutocompleteResponse.html b/interfaces/PlaceQueryAutocompleteResponse.html index 94e33be8cc..40d5b674d6 100644 --- a/interfaces/PlaceQueryAutocompleteResponse.html +++ b/interfaces/PlaceQueryAutocompleteResponse.html @@ -1,2 +1,2 @@ -PlaceQueryAutocompleteResponse | Google Maps Services Node Client
    interface PlaceQueryAutocompleteResponse {
        data: PlaceQueryAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceQueryAutocompleteResponse

    Properties

    Properties

    \ No newline at end of file +PlaceQueryAutocompleteResponse | Google Maps Services Node Client
    interface PlaceQueryAutocompleteResponse {
        data: PlaceQueryAutocompleteResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlaceQueryAutocompleteResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/PlaceQueryAutocompleteResponseData.html b/interfaces/PlaceQueryAutocompleteResponseData.html index 986b7badb2..8036be0d90 100644 --- a/interfaces/PlaceQueryAutocompleteResponseData.html +++ b/interfaces/PlaceQueryAutocompleteResponseData.html @@ -1,17 +1,17 @@ -PlaceQueryAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponseData

    interface PlaceQueryAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceQueryAutocompletePrediction[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +PlaceQueryAutocompleteResponseData | Google Maps Services Node Client

    Interface PlaceQueryAutocompleteResponseData

    interface PlaceQueryAutocompleteResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        predictions: PlaceQueryAutocompletePrediction[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -

    contains an array of places, with information about the place. +

    contains an array of places, with information about the place. See Place Autocomplete Results for information about these results. The Places API returns up to 5 results.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/PlaceReview.html b/interfaces/PlaceReview.html index 53d17f1e2b..f2abd9d515 100644 --- a/interfaces/PlaceReview.html +++ b/interfaces/PlaceReview.html @@ -1,4 +1,4 @@ -PlaceReview | Google Maps Services Node Client
    interface PlaceReview {
        aspects: AspectRating[];
        author_name: string;
        author_url?: string;
        language: string;
        profile_photo_url: string;
        rating: number;
        relative_time_description: string;
        text: string;
        time: string;
    }

    Properties

    aspects +PlaceReview | Google Maps Services Node Client
    interface PlaceReview {
        aspects: AspectRating[];
        author_name: string;
        author_url?: string;
        language: string;
        profile_photo_url: string;
        rating: number;
        relative_time_description: string;
        text: string;
        time: string;
    }

    Properties

    Properties

    aspects: AspectRating[]

    contains a collection of AspectRating objects, each of which provides a rating of a single attribute of the establishment. The first object in the collection is considered the primary aspect.

    -
    author_name: string

    the name of the user who submitted the review. Anonymous reviews are attributed to "A Google user".

    -
    author_url?: string

    the URL to the user's Google Maps Local Guides profile, if available.

    -
    language: string

    an IETF language code indicating the language used in the user's review. +

    author_name: string

    the name of the user who submitted the review. Anonymous reviews are attributed to "A Google user".

    +
    author_url?: string

    the URL to the user's Google Maps Local Guides profile, if available.

    +
    language: string

    an IETF language code indicating the language used in the user's review. This field contains the main language tag only, and not the secondary tag indicating country or region. For example, all the English reviews are tagged as 'en', and not 'en-AU' or 'en-UK' and so on.

    -
    profile_photo_url: string

    the URL to the user's profile photo, if available.

    -
    rating: number

    the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

    -
    relative_time_description: string
    text: string

    the user's review. When reviewing a location with Google Places, text reviews are considered optional. +

    profile_photo_url: string

    the URL to the user's profile photo, if available.

    +
    rating: number

    the user's overall rating for this place. This is a whole number, ranging from 1 to 5.

    +
    relative_time_description: string
    text: string

    the user's review. When reviewing a location with Google Places, text reviews are considered optional. Therefore, this field may by empty. Note that this field may include simple HTML markup. For example, the entity reference &amp; may represent an ampersand character.

    -
    time: string

    the time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC.

    -
    \ No newline at end of file +
    time: string

    the time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC.

    +
    \ No newline at end of file diff --git a/interfaces/PlacesNearbyRequest.html b/interfaces/PlacesNearbyRequest.html index f410a0bee5..66b1561a41 100644 --- a/interfaces/PlacesNearbyRequest.html +++ b/interfaces/PlacesNearbyRequest.html @@ -1,4 +1,4 @@ -PlacesNearbyRequest | Google Maps Services Node Client
    interface PlacesNearbyRequest {
        params: {
            keyword?: string;
            language?: Language;
            location: LatLng;
            maxprice?: number;
            minprice?: number;
            name?: string;
            opennow?: boolean;
            pagetoken?: string;
            radius?: number;
            rankby?: PlacesNearbyRanking;
            type?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacesNearbyRequest

    Properties

    params +PlacesNearbyRequest | Google Maps Services Node Client
    interface PlacesNearbyRequest {
        params: {
            keyword?: string;
            language?: Language;
            location: LatLng;
            maxprice?: number;
            minprice?: number;
            name?: string;
            opennow?: boolean;
            pagetoken?: string;
            radius?: number;
            rankby?: PlacesNearbyRanking;
            type?: string;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • PlacesNearbyRequest

    Properties

    Properties

    params: {
        keyword?: string;
        language?: Language;
        location: LatLng;
        maxprice?: number;
        minprice?: number;
        name?: string;
        opennow?: boolean;
        pagetoken?: string;
        radius?: number;
        rankby?: PlacesNearbyRanking;
        type?: string;
    } & RequestParams

    Type declaration

    • Optional keyword?: string

      A term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

    • Optional language?: Language

      The language code, indicating in which language the results should be returned, if possible. @@ -28,4 +28,4 @@

    • Optional type?: string

      Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PlacesNearbyResponse.html b/interfaces/PlacesNearbyResponse.html index b0e60e3588..562de352a6 100644 --- a/interfaces/PlacesNearbyResponse.html +++ b/interfaces/PlacesNearbyResponse.html @@ -1,2 +1,2 @@ -PlacesNearbyResponse | Google Maps Services Node Client
    interface PlacesNearbyResponse {
        data: PlacesNearbyResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlacesNearbyResponse

    Properties

    Properties

    \ No newline at end of file +PlacesNearbyResponse | Google Maps Services Node Client
    interface PlacesNearbyResponse {
        data: PlacesNearbyResponseData;
    }

    Hierarchy

    • AxiosResponse
      • PlacesNearbyResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/PlacesNearbyResponseData.html b/interfaces/PlacesNearbyResponseData.html index d9b4258e8b..73e6e5b1c3 100644 --- a/interfaces/PlacesNearbyResponseData.html +++ b/interfaces/PlacesNearbyResponseData.html @@ -1,14 +1,14 @@ -PlacesNearbyResponseData | Google Maps Services Node Client
    interface PlacesNearbyResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +PlacesNearbyResponseData | Google Maps Services Node Client
    interface PlacesNearbyResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    results: Partial<PlaceData>[]
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    results: Partial<PlaceData>[]
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/PlusCode.html b/interfaces/PlusCode.html index cfa5c47f7d..9a7dcee574 100644 --- a/interfaces/PlusCode.html +++ b/interfaces/PlusCode.html @@ -1,5 +1,5 @@ -PlusCode | Google Maps Services Node Client
    interface PlusCode {
        compound_code: string;
        global_code: string;
    }

    Properties

    compound_code +PlusCode | Google Maps Services Node Client
    interface PlusCode {
        compound_code: string;
        global_code: string;
    }

    Properties

    compound_code: string

    is a 6 character or longer local code with an explicit location (CWC8+R9, Mountain View, CA, USA).

    -
    global_code: string

    is a 4 character area code and 6 character or longer local code (849VCWC8+R9).

    -
    \ No newline at end of file +
    global_code: string

    is a 4 character area code and 6 character or longer local code (849VCWC8+R9).

    +
    \ No newline at end of file diff --git a/interfaces/PositionalElevationParams.html b/interfaces/PositionalElevationParams.html index 9ea1d35449..ee1459fcaf 100644 --- a/interfaces/PositionalElevationParams.html +++ b/interfaces/PositionalElevationParams.html @@ -1,5 +1,5 @@ -PositionalElevationParams | Google Maps Services Node Client
    interface PositionalElevationParams {
        locations: LatLng[];
    }

    Properties

    locations +PositionalElevationParams | Google Maps Services Node Client
    interface PositionalElevationParams {
        locations: LatLng[];
    }

    Properties

    Properties

    locations: LatLng[]

    defines the location(s) on the earth from which to return elevation data. This parameter takes either a single location as a comma-separated {latitude,longitude} pair (e.g. "40.714728,-73.998672") or multiple latitude/longitude pairs passed as an array or as an encoded polyline.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/PredictionSubstring.html b/interfaces/PredictionSubstring.html index 254199a162..9f93d6102d 100644 --- a/interfaces/PredictionSubstring.html +++ b/interfaces/PredictionSubstring.html @@ -1,5 +1,5 @@ -PredictionSubstring | Google Maps Services Node Client
    interface PredictionSubstring {
        length: number;
        offset: number;
    }

    Properties

    length +PredictionSubstring | Google Maps Services Node Client
    interface PredictionSubstring {
        length: number;
        offset: number;
    }

    Properties

    Properties

    length: number

    length of the entered term.

    -
    offset: number

    location of the entered term.

    -
    \ No newline at end of file +
    offset: number

    location of the entered term.

    +
    \ No newline at end of file diff --git a/interfaces/PredictionTerm.html b/interfaces/PredictionTerm.html index e8a3b339f3..8d5ff3ecbe 100644 --- a/interfaces/PredictionTerm.html +++ b/interfaces/PredictionTerm.html @@ -1,5 +1,5 @@ -PredictionTerm | Google Maps Services Node Client
    interface PredictionTerm {
        offset: number;
        value: string;
    }

    Properties

    offset +PredictionTerm | Google Maps Services Node Client
    interface PredictionTerm {
        offset: number;
        value: string;
    }

    Properties

    Properties

    offset: number

    start position of this term in the description, measured in Unicode characters.

    -
    value: string

    containing the text of the term.

    -
    \ No newline at end of file +
    value: string

    containing the text of the term.

    +
    \ No newline at end of file diff --git a/interfaces/PremiumPlanParams.html b/interfaces/PremiumPlanParams.html index feff28b927..881437bcc7 100644 --- a/interfaces/PremiumPlanParams.html +++ b/interfaces/PremiumPlanParams.html @@ -1,8 +1,8 @@ PremiumPlanParams | Google Maps Services Node Client

    The Google Maps Platform Premium Plan is no longer available for sign up or new customers. This option is only provided for maintaining existing legacy applications that use client IDs. For new applications, please use API keys.

    -

    Deprecated

    interface PremiumPlanParams {
        client_id: string;
        client_secret: string;
    }

    Properties

    Deprecated

    interface PremiumPlanParams {
        client_id: string;
        client_secret: string;
    }

    Properties

    client_id: string

    project client ID

    -
    client_secret: string

    project URL signing secret. Used to create the request signature

    -
    \ No newline at end of file +
    client_secret: string

    project URL signing secret. Used to create the request signature

    +
    \ No newline at end of file diff --git a/interfaces/ResponseData.html b/interfaces/ResponseData.html index 942c342eeb..086cac65cf 100644 --- a/interfaces/ResponseData.html +++ b/interfaces/ResponseData.html @@ -1,13 +1,13 @@ -ResponseData | Google Maps Services Node Client
    interface ResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +ResponseData | Google Maps Services Node Client
    interface ResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/ReverseGeocodeRequest.html b/interfaces/ReverseGeocodeRequest.html index b8a0a160d0..5245e11b62 100644 --- a/interfaces/ReverseGeocodeRequest.html +++ b/interfaces/ReverseGeocodeRequest.html @@ -1,4 +1,4 @@ -ReverseGeocodeRequest | Google Maps Services Node Client
    interface ReverseGeocodeRequest {
        params: {
            enable_address_descriptor?: boolean;
            language?: Language;
            latlng?: LatLng;
            location_type?: ReverseGeocodingLocationType[];
            place_id?: string;
            result_type?: AddressType[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ReverseGeocodeRequest

    Properties

    params +ReverseGeocodeRequest | Google Maps Services Node Client
    interface ReverseGeocodeRequest {
        params: {
            enable_address_descriptor?: boolean;
            language?: Language;
            latlng?: LatLng;
            location_type?: ReverseGeocodingLocationType[];
            place_id?: string;
            result_type?: AddressType[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • ReverseGeocodeRequest

    Properties

    Properties

    params: {
        enable_address_descriptor?: boolean;
        language?: Language;
        latlng?: LatLng;
        location_type?: ReverseGeocodingLocationType[];
        place_id?: string;
        result_type?: AddressType[];
    } & RequestParams

    Type declaration

    • Optional enable_address_descriptor?: boolean

      Determines whether the address descriptor is returned in the response.

    • Optional language?: Language

      The language in which to return results.

        @@ -28,4 +28,4 @@ Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s). Note: This parameter is available only for requests that include an API key or a client ID.

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/ReverseGeocodeResponse.html b/interfaces/ReverseGeocodeResponse.html index 391698dba8..4aef755dc3 100644 --- a/interfaces/ReverseGeocodeResponse.html +++ b/interfaces/ReverseGeocodeResponse.html @@ -1,2 +1,2 @@ -ReverseGeocodeResponse | Google Maps Services Node Client
    interface ReverseGeocodeResponse {
        data: ReverseGeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ReverseGeocodeResponse

    Properties

    Properties

    \ No newline at end of file +ReverseGeocodeResponse | Google Maps Services Node Client
    interface ReverseGeocodeResponse {
        data: ReverseGeocodeResponseData;
    }

    Hierarchy

    • AxiosResponse
      • ReverseGeocodeResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/ReverseGeocodeResponseData.html b/interfaces/ReverseGeocodeResponseData.html index 7c5f853184..c5b1f2c47d 100644 --- a/interfaces/ReverseGeocodeResponseData.html +++ b/interfaces/ReverseGeocodeResponseData.html @@ -1,19 +1,19 @@ -ReverseGeocodeResponseData | Google Maps Services Node Client
    interface ReverseGeocodeResponseData {
        address_descriptor: AddressDescriptor;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    address_descriptor +ReverseGeocodeResponseData | Google Maps Services Node Client
    interface ReverseGeocodeResponseData {
        address_descriptor: AddressDescriptor;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: GeocodeResult[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    address_descriptor: AddressDescriptor

    The Address Descriptor for the target.

    -
    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    +
    results: GeocodeResult[]

    contains an array of geocoded address information and geometry information.

    Generally, only one entry in the "results" array is returned for address lookups,though the geocoder may return several results when address queries are ambiguous.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/RouteLeg.html b/interfaces/RouteLeg.html index 3c74642aff..ea7c24bc67 100644 --- a/interfaces/RouteLeg.html +++ b/interfaces/RouteLeg.html @@ -1,7 +1,7 @@ RouteLeg | Google Maps Services Node Client

    A single leg of the journey from the origin to the destination in the calculated route. For routes that contain no waypoints, the route will consist of a single "leg," but for routes that define one or more waypoints, the route will consist of one or more legs, corresponding to the specific legs of the journey.

    -
    interface RouteLeg {
        arrival_time: Time;
        departure_time: Time;
        distance: Distance;
        duration: Duration;
        duration_in_traffic?: Duration;
        end_address: string;
        end_location: LatLngLiteral;
        start_address: string;
        start_location: LatLngLiteral;
        steps: DirectionsStep[];
    }

    Properties

    interface RouteLeg {
        arrival_time: Time;
        departure_time: Time;
        distance: Distance;
        duration: Duration;
        duration_in_traffic?: Duration;
        end_address: string;
        end_location: LatLngLiteral;
        start_address: string;
        start_location: LatLngLiteral;
        steps: DirectionsStep[];
    }

    Properties

    arrival_time: Time

    contains the estimated time of arrival for this leg. This property is only returned for transit directions.

    -
    departure_time: Time

    contains the estimated time of departure for this leg, specified as a Time object. +

    departure_time: Time

    contains the estimated time of departure for this leg, specified as a Time object. The departure_time is only available for transit directions.

    -
    distance: Distance

    indicates the total distance covered by this leg, as a field with the following elements.

    +
    distance: Distance

    indicates the total distance covered by this leg, as a field with the following elements.

    This field may be absent if the distance is unknown.

    -
    duration: Duration

    indicates the total duration of this leg.

    +
    duration: Duration

    indicates the total duration of this leg.

    This field may be absent if the duration is unknown.

    -
    duration_in_traffic?: Duration

    indicates the total duration of this leg. +

    duration_in_traffic?: Duration

    indicates the total duration of this leg. This value is an estimate of the time in traffic based on current and historical traffic conditions. See the traffic_model request parameter for the options you can use to request that the returned value is optimistic, pessimistic, or a best-guess estimate. The duration in traffic is returned only if all of the following are true:

    @@ -30,15 +30,15 @@
  • The request includes a departure_time parameter.
  • Traffic conditions are available for the requested route.
  • -
    end_address: string

    contains the human-readable address (typically a street address) from reverse geocoding the end_location of this leg.

    -
    end_location: LatLngLiteral

    contains the latitude/longitude coordinates of the given destination of this leg. +

    end_address: string

    contains the human-readable address (typically a street address) from reverse geocoding the end_location of this leg.

    +
    end_location: LatLngLiteral

    contains the latitude/longitude coordinates of the given destination of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, end_location may be different than the provided destination of this leg if, for example, a road is not near the destination.

    -
    start_address: string

    contains the human-readable address (typically a street address) resulting from reverse geocoding the start_location of this leg.

    -
    start_location: LatLngLiteral

    contains the latitude/longitude coordinates of the origin of this leg. +

    start_address: string

    contains the human-readable address (typically a street address) resulting from reverse geocoding the start_location of this leg.

    +
    start_location: LatLngLiteral

    contains the latitude/longitude coordinates of the origin of this leg. Because the Directions API calculates directions between locations by using the nearest transportation option (usually a road) at the start and end points, start_location may be different than the provided origin of this leg if, for example, a road is not near the origin.

    -

    contains an array of steps denoting information about each separate step of the leg of the journey.

    -
    \ No newline at end of file +
    steps: DirectionsStep[]

    contains an array of steps denoting information about each separate step of the leg of the journey.

    +
    \ No newline at end of file diff --git a/interfaces/SampledPathElevationParams.html b/interfaces/SampledPathElevationParams.html index ddb2caed2e..4ea60d08dd 100644 --- a/interfaces/SampledPathElevationParams.html +++ b/interfaces/SampledPathElevationParams.html @@ -1,9 +1,9 @@ -SampledPathElevationParams | Google Maps Services Node Client
    interface SampledPathElevationParams {
        path: LatLng[];
        samples: number;
    }

    Properties

    path +SampledPathElevationParams | Google Maps Services Node Client
    interface SampledPathElevationParams {
        path: LatLng[];
        samples: number;
    }

    Properties

    Properties

    path: LatLng[]

    defines a path on the earth for which to return elevation data. This parameter defines a set of two or more ordered pairs defining a path along the surface of the earth. This parameter must be used in conjunction with the samples parameter described below.

    -
    samples: number

    specifies the number of sample points along a path for which to return elevation data. +

    samples: number

    specifies the number of sample points along a path for which to return elevation data. The samples parameter divides the given path into an ordered set of equidistant points along the path.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/SnapToRoadsRequest.html b/interfaces/SnapToRoadsRequest.html index 96874c80ca..df325faaa0 100644 --- a/interfaces/SnapToRoadsRequest.html +++ b/interfaces/SnapToRoadsRequest.html @@ -1,4 +1,4 @@ -SnapToRoadsRequest | Google Maps Services Node Client
    interface SnapToRoadsRequest {
        params: {
            interpolate?: boolean;
            path: LatLng[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • SnapToRoadsRequest

    Properties

    params +SnapToRoadsRequest | Google Maps Services Node Client
    interface SnapToRoadsRequest {
        params: {
            interpolate?: boolean;
            path: LatLng[];
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • SnapToRoadsRequest

    Properties

    Properties

    params: {
        interpolate?: boolean;
        path: LatLng[];
    } & RequestParams

    Type declaration

    • Optional interpolate?: boolean

      Whether to interpolate a path to include all points forming the full road-geometry. When true, additional interpolated points will also be returned, resulting in a path that smoothly follows the geometry of the road, even around corners and through tunnels. @@ -13,4 +13,4 @@ To ensure the best snap-to-road quality, you should aim to provide paths on which consecutive pairs of points are within 300m of each other. This will also help in handling any isolated, long jumps between consecutive points caused by GPS signal loss, or noise.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/SnapToRoadsResponse.html b/interfaces/SnapToRoadsResponse.html index 1be7fef808..1d67e9bec8 100644 --- a/interfaces/SnapToRoadsResponse.html +++ b/interfaces/SnapToRoadsResponse.html @@ -1,3 +1,3 @@ -SnapToRoadsResponse | Google Maps Services Node Client
    interface SnapToRoadsResponse {
        data: {
            snappedPoints: SnappedPoint[];
        };
    }

    Hierarchy

    • AxiosResponse
      • SnapToRoadsResponse

    Properties

    data +SnapToRoadsResponse | Google Maps Services Node Client
    interface SnapToRoadsResponse {
        data: {
            snappedPoints: SnappedPoint[];
        };
    }

    Hierarchy

    • AxiosResponse
      • SnapToRoadsResponse

    Properties

    Properties

    data: {
        snappedPoints: SnappedPoint[];
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/SnappedPoint.html b/interfaces/SnappedPoint.html index f87d102eae..2132eaed0d 100644 --- a/interfaces/SnappedPoint.html +++ b/interfaces/SnappedPoint.html @@ -1,17 +1,17 @@ -SnappedPoint | Google Maps Services Node Client
    interface SnappedPoint {
        location: LatLngLiteralVerbose;
        originalIndex: number;
        placeId: string;
    }

    Properties

    location +SnappedPoint | Google Maps Services Node Client
    interface SnappedPoint {
        location: LatLngLiteralVerbose;
        originalIndex: number;
        placeId: string;
    }

    Properties

    Contains a latitude and longitude value.

    -
    originalIndex: number

    An integer that indicates the corresponding value in the original request. +

    originalIndex: number

    An integer that indicates the corresponding value in the original request. Each point in the request maps to at most two segmentsin the response:

    • If there are no nearby roads, no segment is returned.
    • If the nearest road is one-way, one segment is returned.
    • If the nearest road is bidirectional, two segments are returned.
    -
    placeId: string

    A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments. +

    placeId: string

    A unique identifier for a place. All place IDs returned by the Roads API correspond to road segments. Place IDs can be used with other Google APIs, including the Places SDK and the Maps JavaScript API. For example, if you need to get road names for the snapped points returned by the Roads API, you can pass the placeId to the Places SDK or the Geocoding API. Within the Roads API, you can pass the placeId in a speed limits request to determine the speed limit along that road segment.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/StructuredFormatting.html b/interfaces/StructuredFormatting.html index 9bd506ecf1..ef64355f98 100644 --- a/interfaces/StructuredFormatting.html +++ b/interfaces/StructuredFormatting.html @@ -1,11 +1,11 @@ -StructuredFormatting | Google Maps Services Node Client
    interface StructuredFormatting {
        main_text: string;
        main_text_matched_substrings: PredictionSubstring[];
        secondary_text: string;
        secondary_text_matched_substrings: PredictionSubstring[];
    }

    Properties

    main_text +StructuredFormatting | Google Maps Services Node Client
    interface StructuredFormatting {
        main_text: string;
        main_text_matched_substrings: PredictionSubstring[];
        secondary_text: string;
        secondary_text_matched_substrings: PredictionSubstring[];
    }

    Properties

    main_text: string

    contains the main text of a prediction, usually the name of the place.

    -
    main_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    main_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired.

    -
    secondary_text: string

    contains the secondary text of a prediction, usually the location of the place.

    -
    secondary_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of +

    secondary_text: string

    contains the secondary text of a prediction, usually the location of the place.

    +
    secondary_text_matched_substrings: PredictionSubstring[]

    contains an array with offset value and length. These describe the location of the entered term in the prediction result secondary text, so that the term can be highlighted if desired.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/TextSearchRequest.html b/interfaces/TextSearchRequest.html index 1355a20872..f03d15756e 100644 --- a/interfaces/TextSearchRequest.html +++ b/interfaces/TextSearchRequest.html @@ -1,4 +1,4 @@ -TextSearchRequest | Google Maps Services Node Client
    interface TextSearchRequest {
        params: {
            language?: Language;
            location?: LatLng;
            maxprice?: number;
            minprice?: number;
            opennow?: boolean;
            pagetoken?: string;
            query: string;
            radius?: number;
            region?: string;
            type?: PlaceType1;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TextSearchRequest

    Properties

    params +TextSearchRequest | Google Maps Services Node Client
    interface TextSearchRequest {
        params: {
            language?: Language;
            location?: LatLng;
            maxprice?: number;
            minprice?: number;
            opennow?: boolean;
            pagetoken?: string;
            query: string;
            radius?: number;
            region?: string;
            type?: PlaceType1;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TextSearchRequest

    Properties

    Properties

    params: {
        language?: Language;
        location?: LatLng;
        maxprice?: number;
        minprice?: number;
        opennow?: boolean;
        pagetoken?: string;
        query: string;
        radius?: number;
        region?: string;
        type?: PlaceType1;
    } & RequestParams

    Type declaration

    • Optional language?: Language

      The language code, indicating in which language the results should be returned, if possible. Note that we often update supported languages so this list may not be exhaustive

    • Optional location?: LatLng

      The latitude/longitude around which to retrieve place information. @@ -32,4 +32,4 @@ for results in the specified region.

    • Optional type?: PlaceType1

      Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/TextSearchResponse.html b/interfaces/TextSearchResponse.html index 6d5b51bf80..1939660b9f 100644 --- a/interfaces/TextSearchResponse.html +++ b/interfaces/TextSearchResponse.html @@ -1,2 +1,2 @@ -TextSearchResponse | Google Maps Services Node Client
    interface TextSearchResponse {
        data: TextSearchResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TextSearchResponse

    Properties

    Properties

    \ No newline at end of file +TextSearchResponse | Google Maps Services Node Client
    interface TextSearchResponse {
        data: TextSearchResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TextSearchResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/TextSearchResponseData.html b/interfaces/TextSearchResponseData.html index 8a5a5ebc37..0f4122349c 100644 --- a/interfaces/TextSearchResponseData.html +++ b/interfaces/TextSearchResponseData.html @@ -1,14 +1,14 @@ -TextSearchResponseData | Google Maps Services Node Client
    interface TextSearchResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message +TextSearchResponseData | Google Maps Services Node Client
    interface TextSearchResponseData {
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        results: Partial<PlaceData>[];
        status: Status;
    }

    Hierarchy (view full)

    Properties

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    results: Partial<PlaceData>[]
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    \ No newline at end of file +
    results: Partial<PlaceData>[]
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    \ No newline at end of file diff --git a/interfaces/Time.html b/interfaces/Time.html index 57ba941e07..4d0acc119b 100644 --- a/interfaces/Time.html +++ b/interfaces/Time.html @@ -1,8 +1,8 @@ -Time | Google Maps Services Node Client
    interface Time {
        text: string;
        time_zone: string;
        value: Date;
    }

    Properties

    text +Time | Google Maps Services Node Client
    interface Time {
        text: string;
        time_zone: string;
        value: Date;
    }

    Properties

    Properties

    text: string

    the time specified as a string. The time is displayed in the time zone of the transit stop.

    -
    time_zone: string

    contains the time zone of this station. The value is the name of the time zone as defined in the +

    time_zone: string

    contains the time zone of this station. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York".

    -
    value: Date

    the time specified as a JavaScript Date object.

    -
    \ No newline at end of file +
    value: Date

    the time specified as a JavaScript Date object.

    +
    \ No newline at end of file diff --git a/interfaces/TimeZoneRequest.html b/interfaces/TimeZoneRequest.html index ca41b6ff87..d3adcc820c 100644 --- a/interfaces/TimeZoneRequest.html +++ b/interfaces/TimeZoneRequest.html @@ -1,4 +1,4 @@ -TimeZoneRequest | Google Maps Services Node Client
    interface TimeZoneRequest {
        params: {
            language?: Language;
            location: LatLng;
            timestamp: number | Date;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TimeZoneRequest

    Properties

    params +TimeZoneRequest | Google Maps Services Node Client
    interface TimeZoneRequest {
        params: {
            language?: Language;
            location: LatLng;
            timestamp: number | Date;
        } & RequestParams;
    }

    Hierarchy

    • Partial<AxiosRequestConfig>
      • TimeZoneRequest

    Properties

    Properties

    params: {
        language?: Language;
        location: LatLng;
        timestamp: number | Date;
    } & RequestParams

    Type declaration

    • Optional language?: Language

      The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.

      Default

      Language.English
      @@ -9,4 +9,4 @@
       based on the time zone of the location. Note that the API does not take historical time zones into account.
       That is, if you specify a past timestamp, the API does not take into account the possibility that
       the location was previously in a different time zone.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/TimeZoneResponse.html b/interfaces/TimeZoneResponse.html index 52dbd20b4a..95e0f061e4 100644 --- a/interfaces/TimeZoneResponse.html +++ b/interfaces/TimeZoneResponse.html @@ -1,2 +1,2 @@ -TimeZoneResponse | Google Maps Services Node Client
    interface TimeZoneResponse {
        data: TimeZoneResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TimeZoneResponse

    Properties

    Properties

    \ No newline at end of file +TimeZoneResponse | Google Maps Services Node Client
    interface TimeZoneResponse {
        data: TimeZoneResponseData;
    }

    Hierarchy

    • AxiosResponse
      • TimeZoneResponse

    Properties

    Properties

    \ No newline at end of file diff --git a/interfaces/TimeZoneResponseData.html b/interfaces/TimeZoneResponseData.html index 1b8afb72e0..87d530748a 100644 --- a/interfaces/TimeZoneResponseData.html +++ b/interfaces/TimeZoneResponseData.html @@ -1,4 +1,4 @@ -TimeZoneResponseData | Google Maps Services Node Client
    interface TimeZoneResponseData {
        dstOffset: number;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        rawOffset: number;
        status: Status;
        timeZoneId: string;
        timeZoneName: string;
    }

    Hierarchy (view full)

    Properties

    dstOffset +TimeZoneResponseData | Google Maps Services Node Client
    interface TimeZoneResponseData {
        dstOffset: number;
        error_message: string;
        html_attributions?: string[];
        next_page_token?: string;
        rawOffset: number;
        status: Status;
        timeZoneId: string;
        timeZoneName: string;
    }

    Hierarchy (view full)

    Properties

    dstOffset: number

    the offset for daylight-savings time in seconds. This will be zero if the time zone is not in Daylight Savings Time during the specified timestamp.

    -
    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information +

    error_message: string

    When the top-level status code is other than OK, this field contains more detailed information about the reasons behind the given status code.

    -
    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    -
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. +

    html_attributions?: string[]

    may contain a set of attributions about this listing which must be displayed to the user (some listings may not have attribution).

    +
    next_page_token?: string

    contains a token that can be used to return up to 20 additional results. A next_page_token will not be returned if there are no additional results to display. The maximum number of results that can be returned is 60. There is a short delay between when a next_page_token is issued, and when it will become valid.

    -
    rawOffset: number

    the offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.

    -
    status: Status

    contains metadata on the request. See Status Codes below.

    -
    timeZoneId: string

    a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney". +

    rawOffset: number

    the offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.

    +
    status: Status

    contains metadata on the request. See Status Codes below.

    +
    timeZoneId: string

    a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by Unicode Common Locale Data Repository (CLDR) project, and currently available in file timezone.xml. When a timezone has several IDs, the canonical one is returned. In timezone.xml, this is the first alias of each timezone. For example, "Asia/Calcutta" is returned, not "Asia/Kolkata".

    -
    timeZoneName: string

    a string containing the long form name of the time zone. +

    timeZoneName: string

    a string containing the long form name of the time zone. This field will be localized if the language parameter is set. eg. "Pacific Daylight Time" or "Australian Eastern Daylight Time"

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/TransitAgency.html b/interfaces/TransitAgency.html index 871304a3c3..06b568b6b8 100644 --- a/interfaces/TransitAgency.html +++ b/interfaces/TransitAgency.html @@ -1,8 +1,8 @@ TransitAgency | Google Maps Services Node Client

    You must display the names and URLs of the transit agencies servicing the trip results.

    -
    interface TransitAgency {
        name: string;
        phone: string;
        url: string;
    }

    Properties

    interface TransitAgency {
        name: string;
        phone: string;
        url: string;
    }

    Properties

    Properties

    name: string

    contains the name of the transit agency.

    -
    phone: string

    contains the phone number of the transit agency.

    -
    url: string

    contains the URL for the transit agency.

    -
    \ No newline at end of file +
    phone: string

    contains the phone number of the transit agency.

    +
    url: string

    contains the URL for the transit agency.

    +
    \ No newline at end of file diff --git a/interfaces/TransitDetails.html b/interfaces/TransitDetails.html index 5f6f7939ab..516521213e 100644 --- a/interfaces/TransitDetails.html +++ b/interfaces/TransitDetails.html @@ -1,7 +1,7 @@ TransitDetails | Google Maps Services Node Client

    Transit directions return additional information that is not relevant for other modes of transportation. These additional properties are exposed through the transit_details object, returned as a field of an element in the steps[] array. From the TransitDetails object you can access additional information about the transit stop, transit line and transit agency

    -
    interface TransitDetails {
        arrival_stop: TransitStop;
        arrival_time: Time;
        departure_stop: TransitStop;
        departure_time: Time;
        headsign: string;
        headway: number;
        line: TransitLine;
        num_stops: number;
    }

    Properties

    interface TransitDetails {
        arrival_stop: TransitStop;
        arrival_time: Time;
        departure_stop: TransitStop;
        departure_time: Time;
        headsign: string;
        headway: number;
        line: TransitLine;
        num_stops: number;
    }

    Properties

    arrival_stop: TransitStop

    contains information about the stop for this part of the trip.

    -
    arrival_time: Time

    contain the arrival time for this leg of the journey.

    -
    departure_stop: TransitStop

    contains information about the station for this part of the trip.

    -
    departure_time: Time

    contain the departure time for this leg of the journey.

    -
    headsign: string

    specifies the direction in which to travel on this line, as it is marked on the vehicle or at the departure stop. +

    arrival_time: Time

    contain the arrival time for this leg of the journey.

    +
    departure_stop: TransitStop

    contains information about the station for this part of the trip.

    +
    departure_time: Time

    contain the departure time for this leg of the journey.

    +
    headsign: string

    specifies the direction in which to travel on this line, as it is marked on the vehicle or at the departure stop. This will often be the terminus station.

    -
    headway: number

    specifies the expected number of seconds between departures from the same stop at this time. +

    headway: number

    specifies the expected number of seconds between departures from the same stop at this time. For example, with a headway value of 600, you would expect a ten minute wait if you should miss your bus.

    -

    contains information about the transit line used in this step.

    -
    num_stops: number

    contains the number of stops in this step, counting the arrival stop, but not the departure stop. +

    contains information about the transit line used in this step.

    +
    num_stops: number

    contains the number of stops in this step, counting the arrival stop, but not the departure stop. For example, if your directions involve leaving from Stop A, passing through stops B and C, and arriving at stop D, num_stops will return 3.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/TransitFare.html b/interfaces/TransitFare.html index a8fe72bfe9..ff785263e8 100644 --- a/interfaces/TransitFare.html +++ b/interfaces/TransitFare.html @@ -1,7 +1,7 @@ -TransitFare | Google Maps Services Node Client
    interface TransitFare {
        currency: string;
        text: string;
        value: number;
    }

    Properties

    currency +TransitFare | Google Maps Services Node Client
    interface TransitFare {
        currency: string;
        text: string;
        value: number;
    }

    Properties

    Properties

    currency: string

    An ISO 4217 currency code indicating the currency that the amount is expressed in.

    -
    text: string

    The total fare amount, formatted in the requested language.

    -
    value: number

    The total fare amount, in the currency specified above.

    -
    \ No newline at end of file +
    text: string

    The total fare amount, formatted in the requested language.

    +
    value: number

    The total fare amount, in the currency specified above.

    +
    \ No newline at end of file diff --git a/interfaces/TransitLine.html b/interfaces/TransitLine.html index 8d4c66a6d5..02516ea3d8 100644 --- a/interfaces/TransitLine.html +++ b/interfaces/TransitLine.html @@ -1,4 +1,4 @@ -TransitLine | Google Maps Services Node Client
    interface TransitLine {
        agencies: TransitAgency[];
        color: string;
        icon: string;
        name: string;
        short_name: string;
        text_color: string;
        url: string;
        vehicle: TransitVehicle;
    }

    Properties

    agencies +TransitLine | Google Maps Services Node Client
    interface TransitLine {
        agencies: TransitAgency[];
        color: string;
        icon: string;
        name: string;
        short_name: string;
        text_color: string;
        url: string;
        vehicle: TransitVehicle;
    }

    Properties

    agencies color icon name @@ -8,11 +8,11 @@ vehicle

    Properties

    agencies: TransitAgency[]

    is an array containing a single TransitAgency object. The TransitAgency object provides information about the operator of the line

    -
    color: string

    contains the color commonly used in signage for this transit line. The color will be specified as a hex string such as: #FF0033.

    -
    icon: string

    contains the URL for the icon associated with this line.

    -
    name: string

    contains the full name of this transit line. eg. "7 Avenue Express".

    -
    short_name: string

    contains the short name of this transit line. This will normally be a line number, such as "M7" or "355".

    -
    text_color: string

    contains the color of text commonly used for signage of this line. The color will be specified as a hex string.

    -
    url: string

    contains the URL for this transit line as provided by the transit agency.

    -

    contains the type of vehicle used on this line.

    -
    \ No newline at end of file +
    color: string

    contains the color commonly used in signage for this transit line. The color will be specified as a hex string such as: #FF0033.

    +
    icon: string

    contains the URL for the icon associated with this line.

    +
    name: string

    contains the full name of this transit line. eg. "7 Avenue Express".

    +
    short_name: string

    contains the short name of this transit line. This will normally be a line number, such as "M7" or "355".

    +
    text_color: string

    contains the color of text commonly used for signage of this line. The color will be specified as a hex string.

    +
    url: string

    contains the URL for this transit line as provided by the transit agency.

    +

    contains the type of vehicle used on this line.

    +
    \ No newline at end of file diff --git a/interfaces/TransitStop.html b/interfaces/TransitStop.html index 907c3a420e..f7c16d70b7 100644 --- a/interfaces/TransitStop.html +++ b/interfaces/TransitStop.html @@ -1,5 +1,5 @@ -TransitStop | Google Maps Services Node Client
    interface TransitStop {
        location: LatLngLiteral;
        name: string;
    }

    Properties

    location +TransitStop | Google Maps Services Node Client
    interface TransitStop {
        location: LatLngLiteral;
        name: string;
    }

    Properties

    Properties

    location: LatLngLiteral

    the location of the transit station/stop, represented as a lat and lng field.

    -
    name: string

    the name of the transit station/stop. eg. "Union Square".

    -
    \ No newline at end of file +
    name: string

    the name of the transit station/stop. eg. "Union Square".

    +
    \ No newline at end of file diff --git a/interfaces/TransitVehicle.html b/interfaces/TransitVehicle.html index 96ece79076..5d0dc04299 100644 --- a/interfaces/TransitVehicle.html +++ b/interfaces/TransitVehicle.html @@ -1,9 +1,9 @@ -TransitVehicle | Google Maps Services Node Client
    interface TransitVehicle {
        icon: string;
        local_icon: string;
        name: string;
        type: VehicleType;
    }

    Properties

    icon +TransitVehicle | Google Maps Services Node Client
    interface TransitVehicle {
        icon: string;
        local_icon: string;
        name: string;
        type: VehicleType;
    }

    Properties

    icon: string

    contains the URL for an icon associated with this vehicle type.

    -
    local_icon: string

    contains the URL for the icon associated with this vehicle type, based on the local transport signage.

    -
    name: string

    contains the name of the vehicle on this line. eg. "Subway.".

    -

    contains the type of vehicle that runs on this line.

    -
    \ No newline at end of file +
    local_icon: string

    contains the URL for the icon associated with this vehicle type, based on the local transport signage.

    +
    name: string

    contains the name of the vehicle on this line. eg. "Subway.".

    +

    contains the type of vehicle that runs on this line.

    +
    \ No newline at end of file diff --git a/interfaces/WifiAccessPoint.html b/interfaces/WifiAccessPoint.html index 1a373f08ad..5fa1c22e61 100644 --- a/interfaces/WifiAccessPoint.html +++ b/interfaces/WifiAccessPoint.html @@ -1,11 +1,11 @@ -WifiAccessPoint | Google Maps Services Node Client
    interface WifiAccessPoint {
        age?: number;
        channel?: number;
        macAddress: string;
        signalStrength?: number;
        signalToNoiseRatio?: number;
    }

    Properties

    age? +WifiAccessPoint | Google Maps Services Node Client
    interface WifiAccessPoint {
        age?: number;
        channel?: number;
        macAddress: string;
        signalStrength?: number;
        signalToNoiseRatio?: number;
    }

    Properties

    age?: number

    The number of milliseconds since this access point was detected.

    -
    channel?: number

    The channel over which the client is communicating with the acces.

    -
    macAddress: string

    The MAC address of the WiFi node. It's typically called a BSS, BSSID or MAC address. Separators must be : (colon).

    -
    signalStrength?: number

    The current signal strength measured in dBm.

    -
    signalToNoiseRatio?: number

    The current signal to noise ratio measured in dB.

    -
    \ No newline at end of file +
    channel?: number

    The channel over which the client is communicating with the acces.

    +
    macAddress: string

    The MAC address of the WiFi node. It's typically called a BSS, BSSID or MAC address. Separators must be : (colon).

    +
    signalStrength?: number

    The current signal strength measured in dBm.

    +
    signalToNoiseRatio?: number

    The current signal to noise ratio measured in dB.

    +
    \ No newline at end of file diff --git a/types/AddressType.html b/types/AddressType.html index 49979af340..7a959201a5 100644 --- a/types/AddressType.html +++ b/types/AddressType.html @@ -1 +1 @@ -AddressType | Google Maps Services Node Client
    \ No newline at end of file +AddressType | Google Maps Services Node Client
    \ No newline at end of file diff --git a/types/Config.html b/types/Config.html index 39d64ab37d..d86871f503 100644 --- a/types/Config.html +++ b/types/Config.html @@ -1 +1 @@ -Config | Google Maps Services Node Client
    Config: {
        raxConfig?: rax.RetryConfig;
    } & AxiosRequestConfig

    Type declaration

    • Optional raxConfig?: rax.RetryConfig
    \ No newline at end of file +Config | Google Maps Services Node Client
    Config: {
        raxConfig?: rax.RetryConfig;
    } & AxiosRequestConfig

    Type declaration

    • Optional raxConfig?: rax.RetryConfig
    \ No newline at end of file diff --git a/types/GeolocateResponse.html b/types/GeolocateResponse.html index 5b33c39c2f..9fcaf4e3f8 100644 --- a/types/GeolocateResponse.html +++ b/types/GeolocateResponse.html @@ -1 +1 @@ -GeolocateResponse | Google Maps Services Node Client
    \ No newline at end of file +GeolocateResponse | Google Maps Services Node Client
    \ No newline at end of file diff --git a/types/LatLng.html b/types/LatLng.html index 5556266b20..ece69dfa95 100644 --- a/types/LatLng.html +++ b/types/LatLng.html @@ -5,4 +5,4 @@
  • an object with 'lat', 'lng' properties; or
  • an object with 'latitude', 'longitude' properties.
  • -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/LatLngArray.html b/types/LatLngArray.html index 7c8ed187b7..1acd0a2425 100644 --- a/types/LatLngArray.html +++ b/types/LatLngArray.html @@ -1 +1 @@ -LatLngArray | Google Maps Services Node Client
    LatLngArray: [number, number]
    \ No newline at end of file +LatLngArray | Google Maps Services Node Client
    LatLngArray: [number, number]
    \ No newline at end of file diff --git a/types/LatLngString.html b/types/LatLngString.html index e7d9eec7db..fd71afc382 100644 --- a/types/LatLngString.html +++ b/types/LatLngString.html @@ -1 +1 @@ -LatLngString | Google Maps Services Node Client
    LatLngString: string
    \ No newline at end of file +LatLngString | Google Maps Services Node Client
    LatLngString: string
    \ No newline at end of file diff --git a/types/Place.html b/types/Place.html index 9f101c2734..267f512438 100644 --- a/types/Place.html +++ b/types/Place.html @@ -1 +1 @@ -Place | Google Maps Services Node Client
    Place: Partial<PlaceData>
    \ No newline at end of file +Place | Google Maps Services Node Client
    Place: Partial<PlaceData>
    \ No newline at end of file diff --git a/types/RequestParams.html b/types/RequestParams.html index 77ce085770..343cc87063 100644 --- a/types/RequestParams.html +++ b/types/RequestParams.html @@ -9,4 +9,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/AddressType-1.html b/variables/AddressType-1.html index bc5ae954e1..a69ac0624e 100644 --- a/variables/AddressType-1.html +++ b/variables/AddressType-1.html @@ -1 +1 @@ -AddressType | Google Maps Services Node Client
    AddressType: typeof PlaceType1 & typeof PlaceType2 = ...
    \ No newline at end of file +AddressType | Google Maps Services Node Client
    AddressType: typeof PlaceType1 & typeof PlaceType2 = ...
    \ No newline at end of file diff --git a/variables/X_GOOG_MAPS_EXPERIENCE_ID.html b/variables/X_GOOG_MAPS_EXPERIENCE_ID.html index 2be1b06b9b..9fcafa643b 100644 --- a/variables/X_GOOG_MAPS_EXPERIENCE_ID.html +++ b/variables/X_GOOG_MAPS_EXPERIENCE_ID.html @@ -1 +1 @@ -X_GOOG_MAPS_EXPERIENCE_ID | Google Maps Services Node Client

    Variable X_GOOG_MAPS_EXPERIENCE_IDConst

    X_GOOG_MAPS_EXPERIENCE_ID: "X-GOOG-MAPS-EXPERIENCE-ID" = "X-GOOG-MAPS-EXPERIENCE-ID"
    \ No newline at end of file +X_GOOG_MAPS_EXPERIENCE_ID | Google Maps Services Node Client

    Variable X_GOOG_MAPS_EXPERIENCE_IDConst

    X_GOOG_MAPS_EXPERIENCE_ID: "X-GOOG-MAPS-EXPERIENCE-ID" = "X-GOOG-MAPS-EXPERIENCE-ID"
    \ No newline at end of file diff --git a/variables/acceptEncoding.html b/variables/acceptEncoding.html index a563cb5ef1..a8cf4d0c3d 100644 --- a/variables/acceptEncoding.html +++ b/variables/acceptEncoding.html @@ -1 +1 @@ -acceptEncoding | Google Maps Services Node Client
    acceptEncoding: "gzip" = "gzip"
    \ No newline at end of file +acceptEncoding | Google Maps Services Node Client
    acceptEncoding: "gzip" = "gzip"
    \ No newline at end of file diff --git a/variables/defaultHttpsAgent.html b/variables/defaultHttpsAgent.html index 932e708bf0..fd7eff30a1 100644 --- a/variables/defaultHttpsAgent.html +++ b/variables/defaultHttpsAgent.html @@ -1 +1 @@ -defaultHttpsAgent | Google Maps Services Node Client
    defaultHttpsAgent: HttpsAgent = ...
    \ No newline at end of file +defaultHttpsAgent | Google Maps Services Node Client
    defaultHttpsAgent: HttpsAgent = ...
    \ No newline at end of file diff --git a/variables/defaultTimeout.html b/variables/defaultTimeout.html index 2d9a8bc72b..a0de42ecab 100644 --- a/variables/defaultTimeout.html +++ b/variables/defaultTimeout.html @@ -1 +1 @@ -defaultTimeout | Google Maps Services Node Client
    defaultTimeout: 10000 = 10000
    \ No newline at end of file +defaultTimeout | Google Maps Services Node Client
    defaultTimeout: 10000 = 10000
    \ No newline at end of file diff --git a/variables/userAgent.html b/variables/userAgent.html index 0f31b25f59..731e0b164d 100644 --- a/variables/userAgent.html +++ b/variables/userAgent.html @@ -1 +1 @@ -userAgent | Google Maps Services Node Client
    userAgent: string = ...
    \ No newline at end of file +userAgent | Google Maps Services Node Client
    userAgent: string = ...
    \ No newline at end of file diff --git a/variables/version.html b/variables/version.html index 2c543ec1b5..71a2787a91 100644 --- a/variables/version.html +++ b/variables/version.html @@ -1 +1 @@ -version | Google Maps Services Node Client
    version: any = ...
    \ No newline at end of file +version | Google Maps Services Node Client
    version: any = ...
    \ No newline at end of file