Skip to content

Commit 486bb95

Browse files
committed
Update the README
1 parent d5e73c8 commit 486bb95

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -662,19 +662,8 @@ A geographic location in one of the supported formats.
662662

663663
An object containing options used for geocoding.
664664

665-
- `level`: `string`, for overlapping features, the preferred geographic classification of the one to code. If no feature exists at the specified level, the feature at the next-highest level is coded, if any. The possible values map directly to the `level` property of [RegionFeatureProperties](#RegionFeatureProperties) objects.
666-
- `world`
667-
- `union`: European Union
668-
- `subunion`: Outermost Regions of the EU, Overseas Countries and Territories of the EU
669-
- `region`: Africa, Americas, Antarctica, Asia, Europe, Oceania
670-
- `subregion`: Sub-Saharan Africa, North America, Micronesia, etc.
671-
- `intermediateRegion`: Eastern Africa, South America, Channel Islands, etc.
672-
- `sharedLandform`: Great Britain, Macaronesia, Mariana Islands, etc.
673-
- `country`: Ethiopia, Brazil, United States, etc.
674-
- `subcountryGroup`: British Overseas Territories
675-
- `territory`: Puerto Rico, Gurnsey, Hong Kong, etc.
676-
- `subterritory`: Sark, Ascension Island, Diego Garcia, etc.
677-
- `strict`: `boolean`
665+
- `level`: `string`, for overlapping features, the preferred geographic classification of the one to code. If no feature exists at the specified level, the feature at the next-highest level is coded, if any. For possible values, see the `level` property of [RegionFeatureProperties](#RegionFeatureProperties).
666+
- `maxLevel`: `string`, the highest-level that a returned feature may have. Must be greater than or equal to `level`.
678667

679668

680669
<a name="RegionFeature" href="#RegionFeature">#</a> <b>RegionFeature</b>
@@ -700,14 +689,15 @@ An object containing the attributes of a RegionFeature object.
700689
- `members`: `[string]`, the ids of other features this feature entirely contains, the inverse of `groups`
701690
- `level`: `string`, the rough geographic classification of this feature
702691
- `world`
692+
- `unitedNations`: United Nations
703693
- `union`: European Union
704694
- `subunion`: Outermost Regions of the EU, Overseas Countries and Territories of the EU
705695
- `region`: Africa, Americas, Antarctica, Asia, Europe, Oceania
706696
- `subregion`: Sub-Saharan Africa, North America, Micronesia, etc.
707697
- `intermediateRegion`: Eastern Africa, South America, Channel Islands, etc.
708698
- `sharedLandform`: Great Britain, Macaronesia, Mariana Islands, etc.
709699
- `country`: Ethiopia, Brazil, United States, etc.
710-
- `subcountryGroup`: British Overseas Territories
700+
- `subcountryGroup`: British Overseas Territories, Crown Dependencies, etc.
711701
- `territory`: Puerto Rico, Gurnsey, Hong Kong, etc.
712702
- `subterritory`: Sark, Ascension Island, Diego Garcia, etc.
713703
- `isoStatus`: `string`, the status of this feature's ISO 3166-1 code(s), if any

0 commit comments

Comments
 (0)